python-guidelines

Standardize Python project structure, typing, testing, and documentation conventions.

Updated Dec 4, 2025
One-click install
npx skills add https://github.com/jr2804/prompts --skill python-guidelines
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: python-guidelines
Source: https://github.com/jr2804/prompts/tree/main/skills/python/python-guidelines
Command: npx skills add https://github.com/jr2804/prompts --skill python-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides universal Python development guidelines to standardize projects, improve maintainability, and reduce onboarding time across teams.

Core Features & Use Cases

  • Standard project structure templates for Python projects (src/, tests/, docs/).
  • Common patterns for typing, error handling, testing, and documentation to enforce consistency.
  • Use Case: For a new Python project, apply these guidelines to bootstrap a maintainable baseline quickly.

Quick Start

Create a new Python project directory and apply the recommended layout, typing, testing, and documentation standards to establish a solid baseline.

Frequently Asked Questions about python-guidelines

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

FAQPage Schema
What are universal Python guidelines for structuring a new project?

Standard Python project structure uses src/, tests/, and docs/ directories to separate code, tests, and documentation. This layout enforces a consistent baseline that improves maintainability and reduces onboarding time across teams.

How do I set up type hints and testing patterns for a Python project?

To set up type hints and testing patterns, apply common typing and testing conventions to enforce consistency. These guidelines standardize type hint usage and testing patterns to improve code safety and maintainability across new and existing projects.

What's the best way to standardize Python code conventions across multiple teams?

The best way to standardize Python code conventions is to apply universal guidelines covering project structure, typing, testing, and documentation. Standardizing these elements reduces onboarding time and enforces a consistent, maintainable baseline across all teams.

Can I apply Python typing and documentation standards to existing projects?

Yes, you can apply Python typing and documentation standards to existing projects. These guidelines are designed to work across both new and existing Python projects, guiding structure, typing, testing, and documentation to improve overall code quality.

Why do I need standard Python documentation and error handling patterns?

You need standard Python documentation and error handling patterns to enforce consistency and reduce onboarding time. Common patterns for typing, error handling, testing, and documentation ensure code remains safer and easier to maintain across teams.