audreyfeldroy/cookiecutter-pypackage

Features

• Python Language Boilerplates - Provides foundational templates for bootstrapping standardized Python package and project structures.
• Template-Based Project Scaffolders - Uses a Cookiecutter template to generate standardized directory structures and boilerplate for Python packages.
• Python Workflow Automators - Establishes a unified command set for managing dependencies, running tests, and verifying code quality.
• Package Dependency Management - Defines project metadata and separates dependencies into development and documentation groups.
• OIDC Package Publishers - Provides OIDC-based publishing to Python registries to eliminate the need for long-lived API tokens.
• Python Project Scaffolders - Generates new Python projects from templates with standard directory layouts and sensible defaults.
• CI/CD Pipeline Orchestration - Orchestrates automated workflows for linting, type checking, multi-version testing, and documentation deployment.
• CI/CD Workflows - Ships pre-configured automation sequences for testing, validation, and deployment in Python projects.
• Package Registry Publishing - Deploys distribution files to a package registry using secure attestation.
• Python Distribution Packaging - Provides a Cookiecutter template for generating standardized Python project directory layouts.
• Action Hash Pinning - Hardens CI pipelines by referencing specific commit SHAs for external actions to prevent supply chain attacks.
• Project Bootstrapping - Initializes a consistent directory structure and CLI entry points for new Python libraries.
• Code Quality Checks - Runs formatting, linting, and type-checking tools to ensure codebase consistency and quality.
• Documentation Deployment Pipelines - Provides an automated pipeline for extracting docstrings and publishing technical documentation.
• API Documentation Generators - Automatically extracts API references from source code docstrings to generate and deploy themed documentation websites.
• Build Toolchain Hardening - Configures a hardened build environment using commit SHA pinning to prevent malicious injection.
• Command Line Task Runners - Provides a unified command-line interface to trigger linting, type-checking, and testing.
• Development Workflow Configurations - Defines a standardized set of commands for linting, type-checking, and multi-version testing.
• Version Matrix Testing - Executes the same test suite across multiple Python language versions to ensure stability.
• Continuous Integration Checks - Provides automated quality checks including linters and tests triggered by pushes and pull requests.
• Command Line Entry Points - Generates a command-line entry point mapping shell commands to package functions.
• CI Pipeline Hardening - Secures workflows using commit SHA pinning and minimal permission sets to prevent supply chain attacks.
• Software Supply Chain Security - Hardens the software supply chain by pinning actions to SHAs and restricting workflow permissions.
• Automated API Documentation - Provides a system to generate technical API documentation directly from source code docstrings.
• Distribution Packaging - Compiles the project into distributable formats to verify the packaging process.
• Test Coverage Collections - Collects branch coverage metrics across multiple versions and enforces a minimum coverage threshold in the pipeline.

Star history