Cookiecutter template for a Python package. See https://github.com/johnnoone/cookiecutter.
- Free software: BSD license
- Vanilla testing setup with nose and python setup.py test
- Travis-CI: Ready for Travis Continuous Integration testing
- Tox testing: Setup to easily test for Python 2.6, 2.7, 3.3
- Sphinx docs: Documentation ready for generation with, for example, ReadTheDocs
- distutils2 ready with pbr
Generate a Python package project:
cookiecutter https://github.com/johnnoone/cookiecutter-pypackage.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
- audreyr/cookiecutter-pypackage: Initial cookie.
- 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: Fork with py2.7+3.3 optimizations. Flask/Werkzeug-style test runner,
_compat
module and module/doc conventions. SeeREADME.rst
or the github comparison view for exhaustive list of additions and modifications.