cookiecutter-pypackage

A python package template, for use with cookiecutter.

Features

• pytest for testing.
• Sphinx docs using the responsive ReadTheDocs theme.
• setup.py script with useful commands for publishing to the PyPI.
• wheel!
• tox and Travis-CI working out-of-the-box.
• Starter compat.py module for Python 2 and 3 compatibility.
• invoke for build tasks

To use this template

$ pip install cookiecutter
$ cookiecutter https://github.com/sloria/cookiecutter-pypackage.git

You will be prompted for basic info (your name, project name, etc.) which will be used in the template.

That's all you need to get started.

Next steps

• Create the Github repo for your project
• Add the repo Travis-CI.
• Add the repo to ReadTheDocs.
• Release your package to the PyPI. Here's a release checklist: https://gist.github.com/sloria/6277657

License

MIT Licensed.