coding_standards

Verify Python code against project coding standards using py_docstyle and pycodestyle.

164|77|Updated Jul 21, 2025
One-click install
npx skills add https://github.com/alexeygrigorev/workshops --skill coding-standards-alexeygrigorev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: coding_standards
Source: https://github.com/alexeygrigorev/workshops/tree/main/agent-skills/prototype/skills/coding_standards
Command: npx skills add https://github.com/alexeygrigorev/workshops --skill coding-standards-alexeygrigorev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires py_docstyle, pycodestyle, and includes scripts (resource) components.

What problem does it solve?

This Skill helps teams enforce consistent coding standards across Python projects by providing a ready-made template and an automated checker.

Core Features & Use Cases

  • Provide a validated function template pattern that all new code must follow.
  • Run automated standards checks to verify type hints, docstrings, and line length.
  • Code review acceleration: during PR reviews, quickly verify compliance against project conventions.

Quick Start

Read skills/coding_standards/templates/function_template.md to learn the required function template pattern, then run skills/coding_standards/scripts/check_standards.sh to validate code against the standards.

Frequently Asked Questions about coding_standards

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

FAQPage Schema
How do I enforce coding standards across a Python project?

Enforce coding standards by running automated checks that validate type hints, docstrings, and line length against project conventions. This skill provides a template pattern and a checker script using pycodestyle and py_docstyle to verify compliance during code reviews and pre-commit stages.

What should a Python function template include for code reviews?

A validated function template establishes consistent patterns all new code must follow. This skill provides a template in skills/coding_standards/templates/function_template.md that defines the required structure teams should enforce during PR reviews.

Can I automate Python code standard checks in pre-commit workflows?

Yes. Run the check_standards.sh script to automate verification of type hints, docstrings, and line length before commits. The script applies pycodestyle and py_docstyle tools to catch violations early in the development cycle.

How do pycodestyle and py_docstyle work together for code validation?

Pycodestyle validates line length and style conventions; py_docstyle checks docstring compliance. Together they provide comprehensive automated verification of Python coding standards across your project.

What's the fastest way to verify code compliance during pull request reviews?

Use the automated standards checker to quickly verify compliance against project conventions without manual inspection. The script validates type hints, docstrings, and line length, accelerating the review process.

Do I need both pycodestyle and py_docstyle, or can I use one alone?

This skill requires both tools. Pycodestyle handles style and line-length validation while py_docstyle enforces docstring standards. Together they deliver complete coverage of the coding standards template.