Cookiecutter PyPackage

Itching to get a new Python project up and running fast?
This template will auto-generate a bunch of stuff to make your life super easy!

Usage

Make sure you have cookiecutter installed:

pip install cookiecutter

Then start the project creator using this template:

cookiecutter https://github.com/ejolly/cookiecutter-pypackage.git

See it in action

Key Features

• Simple Pypi ready Python package template
• Sphinx documentation with auto-doc from docstrings (with examples)
• Multi-environment testing with tox and pytest (Python 2.7/3.6)
• Quickly bump version with single-command
• Hook to auto-publish to pip when pushing new tags to GH
• Basic travis CI configuration [optional]
• GH-pages hosted documentation in separate branch [optional]
• Readthedocs hosted documentation compatibility [optional]
• Super useful Make commands:
  • make install : local install (editable)
  • make clean : remove docs, build, pyc, and test files
  • make docs : build documentation
  • make test: run multi-environment tests with tox
  • and more...

---

Credit

This template is a modified fork from the awesome: https://github.com/audreyr/cookiecutter.