Deprecated. Use cookiecutter-pylibrary instead!
There's a bare library using this template (if you're curious about the final result): https://github.com/ionelmc/python-nameless-minimal.
|Note:||You should use cookiecutter-pylibrary instead - it's just like this
- BSD 2-clause license.
- Tox for testing Python 2.6, 2.7, 3.3, PyPy etc.
- Travis-CI and Coveralls for continuous testing and coverage tracking (using Tox).
- Documentation with Sphinx, ready for ReadTheDocs.
- Configurations for:
Projects using this template have these minimal dependencies:
- Tox - for running the tests
- Setuptools - for building the package, wheels etc. Now-days Setuptools is widely available, it shouldn't pose a problem :)
Generate your project:
project_name Verbose project name, used in headings (docs, readme, etc) repo_name Repository name on github package_name Python package name (whatever you would import) distribution_name PyPI distribution name (what you would
After this you can create the initial repository (make sure you create an empty Github project):
git init . git add . git commit -m "Initial skel." git remote add origin firstname.lastname@example.org:ionelmc/python-nameless.git git push -u origin master
- Enable the repository in your Travis CI account.
- Enable the repository in your Coveralls account.
- Add the repo to your ReadTheDocs account + turn on the ReadTheDocs
service hook. Don't forget to enable virtualenv and specify
docs/requirements.txtas the requirements file in Advanced Settings.
- Release your package. This template comes with a tox environment (
check) that will:
- Check if your
- Check if the
MANIFEST.inhas any issues.
flake8(a combo of PEP8, pyflakes and McCabe checks)
- Check if your
Not Exactly What You Want?
There's more intricate variant of this template that:
- Has a generator script for the test matrix (there's a
configurescript that generates
- Uses Pytest for the test runner.
- Has support for building C extensions.
If you have criticism or suggestions please open up an Issue or Pull Request.