Designing Python APIs
Python library API design: naming, signatures, deprecation, fail-loud error handling.
Test report
- Verdict
- Tested · Works
- Score
- Tested
- Jul 14, 2026
- Environment
- Claude Code 2.x (agent harness)
- Upstream re-checked
- Aug 10, 2026 · 40281a1
Ran a real API design task (add_task with optional priority/due/recurring/notify): the skill's version enforced keyword-only args to kill a boolean-trap bug the baseline shipped as-is, plus a custom exception hierarchy with hints instead of a bare Exception.
Scored on four weighted criteria — install, triggering, output vs. baseline, docs. How scoring works
- Installs cleanly 4/5
- Triggers reliably 5/5
- Output vs. baseline 9/10
- Docs & honesty 5/5
What Designing Python APIs does
Guides the design of Python library APIs — progressive disclosure, keyword-only argument patterns, custom exception hierarchies, and a detailed 'fail loud, not silent' checklist for avoiding masked errors. Triggers when designing a new library API, reviewing an existing one, or planning a deprecation/versioning change; links out to a companion release-management skill for the deprecation mechanics.
How to install Designing Python APIs
git clone https://github.com/wdm0006/python-skills
cd python-skills
mkdir -p ~/.claude/skills
cp -r skills/python/api-design ~/.claude/skills/designing-python-apis
Skills live in ~/.claude/skills/ (global) or .claude/skills/
(per-project). Restart Claude Code after installing.
Commands — how to trigger Designing Python APIs
-
/designing-python-apisPython library API design: naming, signatures, deprecation, fail-loud error handling.
It also activates on plain-language prompts like these:
-
Help me design the public API for a new Python caching library. -
Review this library's function signatures before we hit v1.0. -
How should I deprecate a parameter without breaking callers?
Frequently asked questions
- Is the Designing Python APIs skill free?
- Yes. The skill itself is free from wdm0006/python-skills. SkillProof publishes the install command and an independent test verdict at no cost.
- Does Designing Python APIs work with Claude Code?
- We tested it with Claude Code 2.x (agent harness) on Jul 14, 2026. Verdict: Tested · Works. Ran a real API design task (add_task with optional priority/due/recurring/notify): the skill's version enforced keyword-only args to kill a boolean-trap bug the baseline shipped as-is, plus a custom exception hierarchy with hints instead of a bare Exception.
- What is the Designing Python APIs SkillProof Score?
- 9.2/10 — installs cleanly 4/5, triggers reliably 5/5, output vs. baseline 9/10, docs & honesty 5/5.
- How do I install Designing Python APIs?
- Copy the install command from this page, run it in your terminal, and restart Claude Code. Skills live in ~/.claude/skills/ (global) or .claude/skills/ inside a project.
- Can I use Designing Python APIs with Cursor, Copilot, Gemini CLI, Codex or other AI tools?
- The SKILL.md format is native to Claude (Claude Code, Desktop, claude.ai). The instructions inside adapt to other assistants: Cursor rules, GitHub Copilot instructions, Windsurf rules, Custom GPTs, AGENTS.md for OpenAI Codex, and GEMINI.md for Google Gemini CLI — our conversion guides cover each, and the free converter on the tools page does the wrapping for you.