Cookiecutter template for a namespaced Python package.
- Free software: BSD license
- Vanilla testing setup with unittest and python setup.py test
- Travis-CI: Ready for Travis Continuous Integration testing
- Tox testing support
- Sphinx docs: Documentation ready for generation with, for example, ReadTheDocs
For more on Cookiecutter, See https://github.com/audreyr/cookiecutter.
Generate a Python package project:
cookiecutter https://github.com/koodaamo/pypkg.namespaced.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
If you have differences in your preferred setup, I encourage you to fork this to create your own version. Or create your own; it doesn't strictly have to be a fork.
I also accept pull requests on this, if they're small, atomic, and if they make my own packaging experience better.