Cookiecutter template for a Python package or project See https://github.com/jwhitlock/cookiecutter-django-jw.git
- Free software: Mozilla Public License Version 2.0
- Vanilla testing setup with unittest and python setup.py test
- Skeleton Django project to support ./manage.py
- Jinja2 / jingo with Bootstrap 3 for templates
- Travis-CI: Ready for Travis Continuous Integration testing
- requires.io: Track your 3rd-party packages https://requires.io
- Tox testing: Setup to easily test for Python 2.7 and 3.4 against Django 1.8
- Sphinx docs: Documentation ready for generation with, for example, ReadTheDocs
- Quick quality check with make qa, 100% coverage and clean PEP8/PEP257
- Release QA check with make qa-all, with clean packaging
- Deploy to Heroku with a button
Generate a Python package project:
cookiecutter https://github.com/jwhitlock/cookiecutter-django-jw.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.
- Add the repo to your requires.io account.
- Release your package the standard Python way. Here's a release checklist: https://gist.github.com/audreyr/5990987
Don't worry, you have options:
- audreyr/cookiecutter-pypackage: The original project
- 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. - Also see the network and family tree for audreyr's repo, and many projects linked from the cookiecutter repo.