What problem does it solve?
This Skill addresses the challenge of maintaining consistent, readable, and maintainable Python code across projects and teams by providing guidelines and tools for code style, linting, formatting, naming conventions, and documentation.
Core Features & Use Cases
- Automated Formatting & Linting: Integrates with tools like
ruff to automatically format code and catch style violations.
- Type Hinting & Checking: Promotes the use of type annotations and integrates with
mypy or pyright for static type analysis.
- Naming Conventions: Enforces PEP 8 compliant naming for variables, functions, classes, and constants.
- Documentation Standards: Guides the creation of clear, Google-style docstrings for all public APIs.
- Use Case: When starting a new Python project, use this Skill to configure
pyproject.toml with ruff and mypy settings, ensuring all new code adheres to best practices from the outset.
Quick Start
Configure your project's pyproject.toml file to use ruff for linting and formatting, and mypy for type checking.