Python Cookiecutter

A cookiecutter template for python applications

Key features:

• Uses Python Build Reasonableness (pbr)
• Testing with pytest
• tox to run everything from linting and docs to tests
  • Includes a Github action to run tox on new pushes
• Sphinx Documentation for Read the Docs

Usage

Install cookiecutter:

pip install -U cookiecutter

Generate a new python project using this template:

cookiecutter https://codebase.helmholtz.cloud/m-team/web-doc/python3-template

Use the created project:

# test the generated project
tox

# tox will also build the documentation. You will find further instructions for the project in the development section of the documentation.
# Access it using:
<your browser> ./doc/build/index.html

# Cookiecutter will also initialize a git repository for the project. You only need to push the code afterwards:
git push origin

Copyright Notice

This cookiecutter is based on the original cookiecutter-pypackage.