__              _
   _____/ /___  ______  (_)___  __  __
  / ___/ __/ / / / __ \/ / __ \/ / / /
 (__  ) /_/ /_/ / /_/ / / /_/ / /_/ /
/____/\__/\__,_/ .___/_/ .___/\__, /
              /_/     /_/    /____/

stupipy

Note

Full disclosure: this project was an exercise. I wanted to get a feel for a few features of python that I have not used to this point: notably localization.

This project was intended to provide a useful function while I learned something new. Stupipy generates a project structure that fits my coding style standards.

Installation

To install stupipy, execute:

pip install stupipy

Usage

You only need a name for your project to get started. Create a no-frills folder structure by executing:

stupipy new -p mysweetproject

A folder structure will be created with all the files required to distribute your project to pypi. If you have additional needs, stupipy supports the following options:

–font_name, -f

Specifies the font for the ASCII art generated for files. See pyfiglet’s documentation for available fonts.

–sphinx, –no-sphinx

Choice to include sphinx documentation folder/structure. Default is –sphinx.

–locale, no-locale

Choice to include localization folder. Default is –no-locale.

–licensename, -l

Type of license file to generate. Available options are:

  • MIT

  • BSD

  • Apache

  • ISC

  • WTFPL

Default is MIT.

License

Copyright 2022, Jonathan Boone <jeboone@gmail.com>

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and / or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Changelog

Unreleased

Added

  • Core folder structure generation.

  • README file generation.

  • License file generation.

  • Changelog file generation.

  • Locales structure generation.

Indices and tables