What problem does it solve?
This Skill addresses the challenge of maintaining consistent, readable, and maintainable Python code across projects and teams by providing guidance on style, linting, formatting, and documentation.
Core Features & Use Cases
- Automated Formatting: Leverages tools like
ruff to automatically format code according to established standards.
- Linting and Type Checking: Integrates with linters (
ruff) and type checkers (mypy, pyright) to catch errors and enforce type safety.
- Naming Conventions: Guides developers on using clear and consistent naming for variables, functions, classes, and constants.
- Documentation Standards: Promotes the use of clear docstrings (e.g., Google-style) 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 code quality from the outset.
Quick Start
Configure your project's pyproject.toml file to include ruff and mypy settings for code linting and formatting.