Cookiecutter

August 5, 2021

TLDR

cookiecutter is a modern package template based on python best practices.

• GitHub: lukemiloszewski/cookiecutter

Overview

• Make - build automation
• Poetry - dependency management and packaging
• Pre-Commit - git hooks
• Pytest, Pytest-Cov - testing and coverage reports
• FastAPI - API
• Typer - CLI
• Material for MkDocs - documentation
• Black, Isort - code formatting
• Flake8, Mypy, Pydocstyle - code linting
• GitHub Actions - continuous integration and deployment
• Dependabot - automated dependency updates
• GitHub Labeler - automated label management
• Release Drafter - automated release notes

This template supports Python 3.8.x, 3.9.x and 3.10.x.

Usage

Requirements

• Cookiecutter
• Make
• Poetry

Installation

cookiecutter gh:lukemiloszewski/cookiecutter

Configuration

• project_name - project name
• package_name - package name
• package_version - package version
• package_description - package description
• github_homepage - GitHub homepage where the project is hosted
• author_name - author name
• author_email - author email
• use_api - include template for API
• use_cli - include template for CLI
• use_docs - include template for documentation
• use_auto_deploy - include workflow for automatic documentation deployment
• use_auto_publish - include workflow for automatic package publishing
• use_github_actions - include workflows for continuous integration
• use_git - initialize git repository and make initial commit