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
• 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

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 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.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 cookiecutter-pypackage tutorial.