python-cookiecutter

A tool to automatically create a Python project structure ready to release via GitHub and PyPI.

Getting Started

Python-cookiecutter automatically creates a structured project and sets up essential tools, including:

• A blank README.md file for documentation.

• A LICENSE file to define usage rights.

• Pre-commit hooks to maintain code quality.

• Automatic versioning with setuptools_scm.

• A test setup using pytest.

• Automated formatting, testing, and publishing via GitHub Actions.

• A documentation setup with Sphinx.

Project Setup

Installation and Setup

Project Setup

Infrastructure

Pre-commit hooks, Versioning, GitHub Actions & Documentation

Infrastructure

Contributing

How to improve the cookiecutter

Contributing