Cookiecutter PyPackage

Cookiecutter template for a Python package.

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

Features

• Testing setup with pytest
• Linting with flake8 and static code analysis with mypy
• Travis-CI: Ready for Travis Continuous Integration testing
• Tox testing: Setup to easily test for Python 3.5, 3.6, 3.7, 3.8
• Sphinx docs: Documentation ready for generation with, for example, ReadTheDocs
• 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/croesnick/cookiecutter-pypackage.git

Then:

• Create a repo and put it there.
• Add the repo to your Travis-CI account.
• Install the dev requirements (optional: inside a virtualenv): pip install -e .[dev]
• 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.
• Specify your package's requirements (with optional version pinning) inside the setup.py (see: requirements list). For more info about the format of dependencies, compare pip docs for requirements files.
• Activate your project on pyup.io.

For more details, see the cookiecutter-pypackage tutorial.

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.