Cookiecutter PyPackage

Cookiecutter template for a Python package.

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

Features

• Testing setup with pytest and tox
• 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

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 gh:alexrudy/cookiecutter-pypackage

For more details, see the cookiecutter-pypackage tutorial.