My custom Cookiecutter template for a Python package.
- GitHub repo: https://github.com/robertopreste/cc-pypackage/
- Documentation: https://cc-pypackage.readthedocs.io/
- Free software: BSD license
- Testing setup with
python setup.py testor
pytest(used by default)
- Travis-CI: Ready for Travis Continuous Integration testing
- Tox testing: Setup to easily test for Python 3.4, 3.5, 3.6
- Sphinx docs: Documentation ready for generation with, for example, ReadTheDocs
- Bumpversion: 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.password to 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 ReadTheDocs account + turn on the ReadTheDocs service hook.
- Release your package by pushing a new tag to master.
- Add a requirements.txt file 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 cc-pypackage tutorial.