Cookiecutter Python

Cookiecutter template for a Python package based on audreyr's cookiecutter-pypackage.

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

Features

• Testing setup with pytest
• Travis-CI: Ready for Travis Continuous Integration testing
• Appveyor: Ready for Appveyor Continuous Integration testing
• Tox testing: Setup to easily test for Python 2.7, 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:lneisenman/cookiecutter-python

Then:

• Create the corresponding repo in Github.
• Add the repo to your Travis-CI account.
• Add the repo to your Appveyor account.
• Add the repo to your Coveralls account.
• Git init
• Git add .
• Git commit -m "Initial commit"
• follow the instructions from Github to point your local repo to Github and push your repo
• Update the badges
• Run the script travis_pypi_setup.py to encrypt your PyPI password in Travis config and activate automated deployment on PyPI when you push a new tag to master branch. (Optional)
• Add the repo to your ReadTheDocs account + turn on the ReadTheDocs service hook.
• Release your package by pushing a new tag to master.

For more details, see the cookiecutter-pypackage tutorial.