Skip to content

The pycreator allows creating a boilerplate Python application for the command line easy! Just install and type `pycreator goes brr` to create a `brr` application 😎

License

Notifications You must be signed in to change notification settings

NexSabre/pycreator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

37 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

PyPI version

pycreator

Create boilerplate application thru the command-line!

TLDR;

pip install pycreator # to install pycreator pycreator goes brrr # where brr is the name 

Usage

create

This command allow to create a Python boilerplate application with the structure as showed below. Available commands for create:

-n, --name -- application name (required) -l, --location -- location to create a new package. If none it will create at working directory 

Structure of example application named brrr (pycreator create -n brrr)

brrr β”‚ LICENSE.md β”‚ README.md β”‚ VERSION β”‚ └───src └───brrr β”‚ setup.py β”‚ __init__.py β”‚ β”œβ”€β”€β”€actions β”‚ β”‚ action.py β”‚ β”‚ action_dispatcher.py β”‚ β”‚ version.py β”‚ β”‚ __init__.py β”‚ β”‚ β”‚ └───example_action β”‚ example_action.py β”‚ __init__.py β”‚ β”œβ”€β”€β”€core β”‚ __init__.py β”‚ β”œβ”€β”€β”€framework β”‚ messages.py β”‚ __init__.py β”‚ └───main main.py __init__.py 

add

Note: This is experimental function and it does not work always correct

The add function allow to add a new action into actions directory. To use it please be at brrr directory under src (please see an example above) and the type:

pycreator add -n action_name 

New folder action_name and action_name.py will be created.

Note: Please import a new action in actions_dispatcher.py file manually.

New action should be added here, into ACTION_HANDLERS

class ActionDispatcher: ACTION_HANDLERS = [AddAction, CreateAction, GoesAction, ShowVersion] 

Build

Boilerplate app comes with preconfigured setup.py file which allow to create a .whl package. To build a package, go to src dir a type in the terminal:

pip install setuptools wheel python setup.py sdist bdist_wheel 

After operation in the newly created dir dist/ you should find a *.tar.gz & *.whl packages.

About

The pycreator allows creating a boilerplate Python application for the command line easy! Just install and type `pycreator goes brr` to create a `brr` application 😎

Topics

Resources

License

Stars

Watchers

Forks