A cookiecutter template that creates a basic Python setuptools project, which can be later on augmented with various optional accessories. See the demo for getting a 1ˢᵗ impression on how this Cookiecutter template can be used, including screenshots of the terminal session.
The resulting project uses
rituals
and invoke
for task automation, and
setuptools
for building and distributing the project.
A provided autoenv script takes care
of creating a fully boot-strapped virtualenv – it can also be used manually
if you don't want to install autoenv.
Other integrated tools are pylint for code quality checking,
pytest for testing support, and a Travis CI configuration.
To ease writing code that supports both Python 2 and Python 3,
Jinja2's _compat module is available in the package, and fitting
__future__ imports are placed in every module.
See Porting to Python 3 Redux
for a pragmatic porting guide, based on actual experience.
| 📚 | Get to know all the details on Read The Docs. |
|---|
Since the files contained in the {{cookiecutter.repo_name}} archetype itself
will comprise the foundation of your project, they're unlicensed using the
“Creative Commons Zero v1.0 Universal” license.
All other files outside the {{cookiecutter.repo_name}} directory are
MIT-licensed – this effectively means you only have to attribute this project
if you re-use all or parts of the contained templating mechanics and documentation.
for the project.
for the template proper (everything in
{{cookiecutter.repo_name}}), unless specified otherwise within the file itself.
Similar Archetypes
-
weber-minimal – A Flask application skeleton with Ansible deployment.
See also the full list at Cookiecutter's README.