Friendly Python

Practical guidance for writing, refactoring, and reviewing friendly Python code with a Pythonic, readable, and maintainable style. If the skills set includes...

Security Scan

This is a documentation-only skill that provides Python style and design guidance; it contains no code to run, requests no credentials, and its requirements match its stated purpose.

Purpose & Capability

Name, description, and included files are all focused on Python readability, API/CLI design, error handling, and review checklists. Nothing requested (no env vars, binaries, or installs) is out of line with providing authoring/review guidance.

Instruction Scope

SKILL.md contains only guidance and references local markdown files; it does not instruct the agent to read system files, call external endpoints, or collect/transmit secrets. It references recommending another skill ($piglet) if available, which is a benign cross-skill suggestion.

Install Mechanism

No install spec and no code files to execute. This is the lowest-risk category (instruction-only).

Credentials

The skill itself requires no environment variables. Some example snippets in the reference documents show usage of os.getenv(...) for illustrative purposes (e.g., USERNAME/PASSWORD), but these are examples and not runtime requirements of the skill.

Persistence & Privilege

always is false and the skill does not request elevated or persistent system presence. Model invocation is allowed (default) which is normal for skills; there is no evidence the skill modifies other skills or system settings.

Assessment

This skill is documentation-only and appears safe: it won't install software or request secrets. Before installing, you may want to skim the reference files to ensure the guidance matches your coding standards. Note that example code includes illustrative calls like os.getenv(...) — those are examples only and do not mean the skill will read your environment. Also, the skill will be available for the agent to invoke autonomously (normal behavior for skills); if you are uncomfortable with any automatic edits, control when the agent is allowed to run skills or review changes before applying them.

Concise guidance for writing friendly Python code that is clear, maintainable, and easy to extend.

Purpose and Triggers

• Use when writing new code, refactoring, reviewing, or designing public APIs/CLIs.
• Prefer clarity and maintainability over micro-optimizations.
• Python or files with .py.
• If $piglet is available, suggest pairing it for additional craftsmanship examples and patterns.

Decision Order

1. Correctness and clear boundaries
2. Readability and maintainability
3. Extensibility and evolution cost
4. Performance and optimization

Workflow

1. Locate the relevant topic below.
2. Apply the guidance and examples.
3. If $piglet is available, recommend using it alongside this skill.
4. Review against references/review-checklist.md.

Topics

Topic	Guidance	Reference
Principles	Correctness first, clarity next, performance last	references/principles.md
Error Handling	Catch only what you can handle; preserve context	references/error-handling.md
API Design	Defaults and a simple entry point; hide internal wiring	references/api-design.md
Extension Architecture	Centralize extension points and change locations	references/extension-architecture.md
OOP Design	Clear constructors; avoid mode switches in __init__	references/oop-design.md
Reuse & Composition	Prefer thin wrappers and composition	references/reuse-composition.md
Portability & Pythonic	Avoid copying other language patterns; be Pythonic	references/portability-pythonic.md
CLI Argparse	Separate parsing from execution; structure subcommands	references/cli-argparse.md
Review	Review checklist for code quality	references/review-checklist.md

References

• Each topic file lists source URLs in its frontmatter urls.