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.
- Install Cookiecutter:
$ pip install cookiecutter
. - Now use Cookiecutter to create your brand new project:
$ cookiecutter https://github.com/Thumperrr/cookiecutter-python-cli.git
When running Cookiecutter, you'll need to provide some values. Here's what they're for:
full_name
-- Author nameemail
-- Author emailgithub_username
-- for automatically including project URLsproject_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.)project_short_description
-- A brief description of the project included in READMEsrelease_date
-- Project release dateyear
-- Release yearversion
-- Release versionlicense
-- Select a license to include in repositoryyear_from
-- copyright year fromyear_to
-- copyright year to
Liberally licensed under MIT terms.