This is a short summary of all the components this project provides along with basic examples.
cookiecutterin your Python environment. Ex:
pip install cookiecutter
Use this template project to generate your project
The Template Variables section defines the Cookiecutter variables that will be prompted and used to configure the generated project.
If you want to work in a Git repository for the generated project see Git Repository.
project_title: The title of the project that is being created.
project_slug: The slug is used to give the Python package an install name. This should be compliant with PEP-0008: Package and Module Names
project_short_description: Project description that will be added to setup.py and published with the package.
project_author_email: The author email address that will be used for license generation and also published with the package in setup.py
project_author_name: The author name that will be used for license generation and also published with the package in setup.py
project_source_url: HTTP accessible URL that can link to the source of the generated project.
project_doc_url: HTTP accessible URL that can link to the documentation of the generated project.
install_requires: List of Python packages, in CSV form, that are required by the generated project at install.
project_extra_dev_requires: List of Python packages, in CSV form, that are required by the generated project during development.
project_extra_test_requires: List of Python packages, in CSV form, that are required to test the generated project.
project_python_max_version: The maximum version of Python the project will be supported on.
project_python_min_version: The minimum version of Python the project will be supported on. Has to be lesser or equal than
project_valid_python_versions: List of Python versions, in CSV form, that are valid. This can be used to define the versions in between
project_python_max_version, inclusive, that this project will be supported on.
initialize_git_repo: If true, will setup a Git repository in the generated project and do an initial commit. You can amend the initial commit or add on top. See Git Repository for more information.
yes (the default) a Git repository
will be initialized in the target repository. This will also do a commit for
you which you can then amend or add on top. This allows you to diff against
the templated project with your own work.
You just have to add the remote to push the Git repository:
git remote add origin <repo url>
If you chose
initialize_git_repo to be
no you can initialize
the Git repository in your templated project later by doing:
git init git add --all git remote add origin <repo url> git push