A default template for a new CLI project, written in Python, to be used with the cookiecutter utility. Deals with all the boilerplate involved in the setuptools setup, etc.
Here's my preferred path to bliss:
- Start by installing
pipenv. It's awesome.$ pip3 install --user pipenv - Now install Cookiecutter:
$ pipenv install cookiecutter. - Now use Cookiecutter to create your brand new project:
$ pipenv run cookiecutter https://github.com/michelraymond/cookiecutter-python-cli
When running Cookiecutter, you'll need to provide some values. Here's what they're for:
project_name-- "My Tool" (Used for marketing. Keep it short and capitalize accordingly.)repo_name-- "python-mytool" (Name of the GitHub repo.)pypi_name-- "mytool" (Name on PyPI, i.e. what people type topip install.)script_name-- "my-tool" (Binary of the script, i.e. what people will run on the command line.)package_name-- "my_tool" (Name of the Python module/package used internally.)
Liberally licensed under BSD terms.