Cookiecutter template for a Python package.
- GitHub repo: https://github.com/audreyfeldroy/cookiecutter-pypackage/
- Documentation: https://cookiecutter-pypackage.readthedocs.io/
- Free software: BSD license
- Testing setup with
python setup.py testor
- Travis-CI: Ready for Travis Continuous Integration testing
- Tox testing: Setup to easily test for Python 3.6, 3.7, 3.8
- 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:
- Create a repo and put it there.
- Add the repo to your Travis-CI account.
- Install the dev requirements into a virtualenv. (
pip install -r requirements_dev.txt)
- Register your project with PyPI.
- Run the Travis CLI command
travis encrypt --add deploy.passwordto encrypt your PyPI password in Travis config and activate automated deployment on PyPI when you push a new tag to master branch.
- Add the repo to your Read the Docs account + turn on the Read the Docs service hook.
- Release your package by pushing a new tag to master.
- Add a
requirements.txtfile that specifies the packages you will need for your project and their versions. For more info see the pip docs for requirements files.
- Activate your project on pyup.io.
For more details, see the cookiecutter-pypackage tutorial.
Not Exactly What You Want?
Don't worry, you have options:
Similar Cookiecutter Templates
- Nekroze/cookiecutter-pypackage: A fork of this with a PyTest test runner,
strict flake8 checking with Travis/Tox, and some docs and
- tony/cookiecutter-pypackage-pythonic: Fork with py2.7+3.3 optimizations.
Flask/Werkzeug-style test runner,
_compatmodule and module/doc conventions. See
README.rstor the github comparison view for exhaustive list of additions and modifications.
- ardydedase/cookiecutter-pypackage: A fork with separate requirements files rather than a requirements list in the
- lgiordani/cookiecutter-pypackage: A fork of Cookiecutter that uses Punch instead of bump2version and with separate requirements files.
- briggySmalls/cookiecutter-pypackage: A fork using Poetry for neat package management and deployment, with linting, formatting, no makefiles and more.
- veit/cookiecutter-namespace-template: A cookiecutter template for python modules with a namespace
- zillionare/cookiecutter-pypackage: A template containing Poetry, Mkdocs, Github CI and many more. It's a template and a package also (can be installed with pip)
- Also see the network and family tree for this repo. (If you find anything that should be listed here, please add it and send a pull request!)
Fork This / Create Your Own
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.
Or Submit a Pull Request
I also accept pull requests on this, if they're small, atomic, and if they make my own packaging experience better.