Cookiecutter template for a Python namespace package
Project description
Cookiecutter Namespace Template for a Python package.
Features
Testing setup with unittest or pytest
Tox testing: Setup to easily test for Python 3.9, 3.10, 3.11, 3.12, 3.13, and pypy.
Sphinx docs: Documentation ready for generation with, for example, ReadTheDocs
Bump My Version: Pre-configured version bumping with a single command
If the cookiecutter-namespace-template project template has been changed, you can apply these changes with
$ cruft updateOptional auto-release to PyPI when you push a new tag to main (optional)
If you really want to create a new package with Python 2, in spite of the Python 2.7 countdown and the Sunsetting Python 2 support, then use cookiecutter-namespace-template <0.2.
Quickstart
Install the latest Cookiecutter if you haven’t installed it yet (this requires Cookiecutter 1.4.0 or higher):
$ python -m pip install -U cruftGenerate a Python package project:
$ python -m cruft create https://github.com/veit/cookiecutter-namespace-template.gitCreate a repo and put it there.
Register your project with PyPI.
Add the repo to your ReadTheDocs account and turn on the ReadTheDocs service hook.
Release your package by pushing a new tag to main.
Pull requests
If you have differences in your preferred setup, I encourage you to fork this to create your own version. I also accept pull requests on this, if they’re small, atomic, and if they make my own packaging experience better.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
