cookiecutter-pypkg

Cookiecutter template for a Python package. See https://github.com/audreyr/cookiecutter.

The basic properties of this package are:

• Free software: MIT license
• Uses a single definition of the package's version within the top __init__.py file.
• PyTest: For code testing.
• Coverage: For tracking test coverage.
• Tox: To test different environments.
• Flake8: To check the coding style.
• Sphinx: Ready for Sphinx documentation auto-generator.
• Travis-CI: Ready for Travis Continuous Integration testing.
• ReadTheDocs: Ready for ReadTheDocs documentation service.
• Wheel: Use the newest python package distribution standard from the get go

Usage

Generate a Python package project:

cookiecutter https://github.com/mdelpozobanos/cookiecutter-pypkg.git

Then:

• Create a repo and put it there.
• Add the repo to your Travis CI account.
• Add the repo to your ReadTheDocs account + turn on the ReadTheDocs service hook.
• Release your package the standard Python way. Here's a release checklist: https://gist.github.com/audreyr/5990987

Not Exactly What You Want?

Don't worry, go back to the origin and check other options. This is a fork of Audrey's cookiecutter python-package. You can also easily create your own template. Check Daniel Greenfeld's blog for a nice explanation on how to do this.