Cookiecutter Python Package

Cookiecutter template for a Python package with pdoc for API docs.

• GitHub repo: https://github.com/gunnarvoet/cookiecutter-python-package/
• Free software: MIT license

Features

• Testing setup with pytest
• pdoc docs: Documentation ready
• Optionally add custom pdoc theme as git submodule
• GitHub action for auto-generating & deploying docs.

Quickstart

Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):

pip install pyyaml
pip install -U cookiecutter

Generate the Python package structure:

cookiecutter https://github.com/gunnarvoet/cookiecutter-python-package.git