skills.rest
Friend09
Friend09COMMUNITY
Explore all skills by this author →
WebsiteGitHub

python-lint-style

Check Python code for docstrings, naming conventions, and import order.

Updated Jul 22, 2025
Search Tags:#python#docstrings#static-analysis#naming-conventions#lint#style-guide#import-order
One-click install
npx skills add https://github.com/Friend09/copilot_practice_material --skill python-lint-style
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: python-lint-style
Source: https://github.com/Friend09/copilot_practice_material/tree/main/demo/advanced/demo10_agent_skills/setup/example_skill
Command: npx skills add https://github.com/Friend09/copilot_practice_material --skill python-lint-style

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Python projects often suffer from missing docstrings, inconsistent naming, and poorly ordered imports, leading to hard-to-maintain code and noisy code reviews.

Core Features & Use Cases

  • Enforces docstrings for modules, classes, and public functions following Google-style format (see resources/style_guide.md).
  • Checks naming conventions (snake_case for functions/variables, PascalCase for classes, UPPER_SNAKE_CASE for constants) and flags deviations.
  • Validates import order across standard library, third-party, and local imports with alphabetical grouping.
  • Detects basic quality gaps like missing type hints and overly complex functions to guide refactoring.

Quick Start

Run the lint_check.py script on a Python file to surface docstring, naming, and import issues.

Frequently Asked Questions about python-lint-style

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

FAQPage Schema
How do I check Python code for missing docstrings and naming convention violations?▼

To check Python code for missing docstrings and naming violations, run the lint script against your files. It identifies modules, classes, and functions lacking Google-style docstrings and flags deviations from snake_case, PascalCase, and UPPER_SNAKE_CASE naming conventions.

How do I automatically validate Python import order for standard library, third-party, and local modules?▼

You can automatically validate Python import order by running the lint check script. It verifies that standard library, third-party, and local imports are correctly grouped and alphabetically ordered to reduce code review noise and maintain consistency.

What is the best way to automate Python style guide compliance across a large project?▼

Automating Python style guide compliance across large projects involves applying static analysis scripts to check for missing docstrings, improper naming, and misordered imports. This supports automated linting and CI checks by surfacing quality gaps consistently.

Does this Python linting approach detect missing type hints and complex functions?▼

Yes, this Python linting approach detects basic quality gaps like missing type hints and overly complex functions. By identifying these issues alongside docstring and naming checks, it guides refactoring efforts to improve overall code maintainability.

Can I use this static analysis tool to support CI checks and automated code reviews?▼

Yes, you can use this static analysis tool to support CI checks and automated code reviews. It surfaces import, naming, and docstring issues across modules, classes, and functions, providing consistent feedback for automated linting pipelines.

Related Skills

Explore More Software Engineering Skills→
AnvinX1AnvinX1

lint-and-validate

Run linting and static analysis on Python and Node.js projects.

Community
Intermediate
pikakitpikakit

code-review

Automate code-quality reviews with linting, static analysis, and security checks.

Community
Advanced
michaelalbermichaelalber
2

python-arch-review

Automate Python code quality checks with Ruff, mypy, radon, bandit, and pytest-cov.

Community
Advanced
raybargasraybargas

Global Coding Style

Detect and fix coding style violations across multi-language repositories.

Community
Basic