convention-python

What problem does it solve?

Python coding conventions provide a centralized reference to ensure consistent style, naming, typing, and documentation across the codebase, reducing cognitive load and review time.

Core Features & Use Cases

• Naming rules: snake_case for variables and functions, PascalCase for classes, UPPER_SNAKE_CASE for constants, and snake_case for modules.
• Style & tooling: follow line-length guidelines (e.g., 79/88 characters), avoid tabs, and enforce a consistent import order (standard library → third-party → local).
• Documentation: require type hints, Google-style docstrings (Korean guidance where applicable), and clear logging/logic notes.
• Use Case: a team aligning a legacy Python project to modern conventions without changing behavior.

Quick Start

Refer to the team’s Python coding conventions when writing or refactoring Python code.