Cookiecutter PyPackage

Cookiecutter template for a Python package.

• GitHub repo: https://github.com/audreyfeldroy/cookiecutter-pypackage/
• Documentation: https://cookiecutter-pypackage.readthedocs.io/
• Free software: BSD license

Features

• Testing setup with unittest and python setup.py test or pytest
• 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)

Build Status

Linux:

Windows:

Quickstart

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/audreyfeldroy/cookiecutter-pypackage.git

Then:

• Create a repo and put it there.
• Install the dev requirements into a virtualenv. (pip install -r requirements_dev.txt)
• Register your project with PyPI.
• Add the PyPI API token as a Github secret PYPI_API_TOKEN
• Release your package by pushing a new tag to master.
• Add the project requirements to the install_requires list in setup.py.

For more details, see the cookiecutter-pypackage tutorial.

Development

To test the cookiecutter locally, run:

# cd out of the cookiecutter-pypackage project directory cd ..;pipx run cookiecutter -f --no-input cookiecutter-pypackage; cd python_boilerplate

To generate a Python package project with your new local cookiecutter, run:

# Generate a Python package project pipx run cookiecutter gh:fortran01/cookiecutter-pypackage

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 setup.py differences.
• tony/cookiecutter-pypackage-pythonic: Fork with py2.7+3.3 optimizations. Flask/Werkzeug-style test runner, _compat module and module/doc conventions. See README.rst or 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 setup.py file.
• 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)
• waynerv/cookiecutter-pypackage: A fork using Poetry, Mkdocs, Pre-commit, Black and Mypy. Run test, staging and release workflows with GitHub Actions, automatically generate release notes from CHANGELOG.
• 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.