Cookiecutter Hipster Pypackage
Cookiecutter template for a cutting-edge Python package: Hatch, ruff, mypy, GitHub Actions and more!
Overview
The Cookiecutter Hipster PyPackageCookiecutter template stands out as a multifunctional tool for developers looking to create cutting-edge Python packages. With a focus on modern programming practices and ease of use, this template incorporates a variety of essential features designed to streamline the development process and enhance productivity. By integrating tools such as uv for dependency management and just for command shortcuts, it offers a robust foundation for any Python project, ensuring that developers can focus on creating high-quality code without getting bogged down by setup.
This template exemplifies a modern approach to Python package creation, emphasizing efficiency and reliability. The incorporation of linting, type checking, and unit testing demonstrates a commitment to code quality, while the ready-to-use GitHub Actions pipelines facilitate continuous integration and deployment. Overall, it's a perfect match for developers who want to leverage the latest tools and methodologies in their work.
Features
- Lightweight Starter: Kickstart your Python package with a minimalistic yet powerful template designed for efficiency.
- Dependency Management with uv: Utilizes uv for fast and accurate dependency resolution, organizing dependencies via PEP 735 groups.
- Command Shortcuts with just: Simplifies command execution for common tasks with just, making your workflow more streamlined and portable.
- Linting and Formatting with ruff: Ensures your code is clean and well-formatted by integrating ruff for linting purposes.
- Type Checking with mypy: Improves code robustness by incorporating mypy for static type checking, catching errors before runtime.
- Unit Tests with pytest: Allows for thorough testing of your codebase, with optional support for asyncio to handle asynchronous code.
- Comprehensive Documentation: Automatically generates documentation using Material for MkDocs, complete with docstring reference support via mkdocstrings.
- Ready-to-Use GitHub Actions Pipelines: Comes with pre-configured GitHub Actions for seamless CI/CD integration, improving deployment efficiency.
- AI-Assisted Development: Provides GitHub Copilot instructions to maintain consistent coding standards when using AI tools.
- MkDocs
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
- Templates & Themes
A template or theme refers to a pre-designed layout or structure that provides a basic framework for building a specific type of application or website. It typically includes good design, placeholder content and functional features, allowing developers to customize and fill in the details according to their specific needs.