python-conventions

Enforce PEP 8 style, type hints, and docstrings in Python code.

Updated Feb 19, 2026
One-click install
npx skills add https://github.com/taewook486/real-estate-mcp --skill python-conventions-taewook486
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: python-conventions
Source: https://github.com/taewook486/real-estate-mcp/tree/main/.claude/skills/python-conventions
Command: npx skills add https://github.com/taewook486/real-estate-mcp --skill python-conventions-taewook486

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the need for consistent, high-quality Python code by enforcing established conventions and best practices, leading to more readable, maintainable, and robust software.

Core Features & Use Cases

  • PEP 8 Compliance: Ensures adherence to Python's official style guide for consistent formatting.
  • Type Hinting: Promotes code clarity and enables static analysis by requiring type annotations.
  • Docstring Standards: Mandates clear and informative docstrings for functions and classes, improving documentation and understanding.
  • Testing Emphasis: Encourages comprehensive testing by requiring unit tests for critical paths and edge cases.
  • Use Case: When developing a new Python module, this Skill will guide the developer to write code that is immediately understandable by teammates and easier to debug and extend.

Quick Start

Apply Python coding conventions, including PEP 8, type hints, and docstrings, to the provided Python code.

Frequently Asked Questions about python-conventions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce PEP 8 style and type hints in Python code?

To enforce PEP 8 style and type hints in Python code, apply established coding conventions that mandate consistent formatting and require type annotations using the typing module. This improves code clarity and enables static analysis for better maintainability.

What are the best practices for writing Python docstrings?

Best practices for writing Python docstrings involve adhering to PEP 257 standards to provide clear, informative documentation for functions and classes. This improves code understanding and maintainability by making module behaviors immediately obvious to teammates.

Why do I need type hints and unit tests for my Python module?

You need type hints and unit tests for your Python module to promote code clarity and ensure robustness. Requiring type annotations enables static analysis, while comprehensive unit testing for critical paths and edge cases guarantees reliable execution and easier debugging.

Do I need prior knowledge of the typing module to apply Python coding conventions?

Yes, you need prior understanding of Python's typing module and PEP 257 for docstring standards to effectively apply these coding conventions. This prerequisite knowledge is required to properly implement type hinting and documentation guidelines in your development workflow.

When should I standardize Python formatting and documentation in my development workflow?

You should standardize Python formatting and documentation in your development workflow when creating a new module. Enforcing conventions early ensures the code is immediately understandable by teammates, easier to debug, and simpler to extend.