Cookiecutter template for a Debian Python Module package.
This is an almost "all inclusive" sort of template.
- Automatic setup of the whole "debian/" subdirectory.
- Support for Python2 and Python3 packages.
- Sphinxdoc integration with a separate documentation package.
To create a package directory structure from this template some packages are required:
- Cookiecutter - just for creating the project
- Jinja2 Time - for displaying the current date and time in templates
To get quickly started on a new Debian system, just run this in your shell or command prompt:
sudo apt install cookiecutter python-jinja2-time
First generate your project:
cookiecutter gh:fladi/cookiecutter-debian-python-module
You will be asked for these fields:
| Template variable | Default | Description |
|---|---|---|
maintainer_name |
"Michael Fladischer" |
Debian maintainer of this package. Can be set in your |
email |
"fladi@debian.org" |
Contact email of the maintainer. Can be set in your |
bug |
"" |
ITP bug number from Debian BTS |
package |
"module" |
The name of the upstream package as seen on PyPI. |
source |
"python-module" |
The name of the Debian source package. |
short_description |
"Some useful Python module" |
Short description for the Debian packages. |
version |
"0.1.0" |
Upstream version to be initially packaged. |
upstream_name |
"Some Name" |
Name of upstream author or primary contact. |
upstream_email |
"someone@example.com" |
Email address of upstream author or primary contact. |
upstream_url |
"https://pypi.python.org/pypi/module" |
URL of upstream website. |
upstrea_copyright |
"2016, Some Name <someone@example.com>" |
Copyright information of upstream project. |
license |
"public domain" |
Upstream license (select from a list of DEP-5 licenses). |
python2_minimum |
"2.5" |
Minimum supported Python2 version (select "unsupported" to disable Python2 support). |
python3_minimum |
"3.0" |
Minimum supported Python3 version (select "unsupported" to disable Python3 support). |
debhelper |
"9" |
Debhelper compatibility level. |
standards_version |
"3.9.8" |
Debian Standards-Version. |
sphinx_root |
"docs" |
Root directory of sphinx buildable documentation. |
If you have criticism or suggestions please open up an Issue or Pull Request.