crumb - Python Package

Cookiecutter template for a Python package.

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

Features

• Testing setup with unittest and python setup.py test or py.test
• Travis-CI_: Ready for Travis Continuous Integration testing
• Tox_ testing: Setup to easily test for Python 2.7, 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)

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 gh:draperjames/crumb-python-package

Then:

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

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 Bumpversion_ and with separate requirements files.