Cookiecutter template for a Python package.
- GitHub repo: https://github.com/jcreinhold/cookiecutter-pypackage/
- Documentation: https://cookiecutter-pypackage.readthedocs.io/
- Free software: BSD license
- Testing setup with
unittest
andpython setup.py test
orpytest
- Github Actions: Ready for GH Actions Continuous Integration testing
- Tox testing: Setup to easily test for Python 3.6, 3.7, 3.8, 3.9
- Sphinx docs: Documentation ready for generation with, for example, Read the Docs
- bump2version: Pre-configured version bumping with a single command
- Auto-release to PyPI when you push a new tag to master (optional)
- Command line interface using Click (optional)
Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):
pip install -U cookiecutter
Generate a Python package project:
cookiecutter https://github.com/jcreinhold/cookiecutter-pypackage.git
For more details, see the cookiecutter-pypackage tutorial.
If you have differences in your preferred setup, I encourage you to fork this to create your own version. Or create your own; it doesn't strictly have to be a fork.
- Once you have your own version working, add it to the Similar Cookiecutter Templates list above with a brief description.
- It's up to you whether or not to rename your fork/own version. Do whatever you think sounds good.
I also accept pull requests on this, if they're small, atomic, and if they make my own packaging experience better.