mcpField
R
reviewing-python-libraries

reviewing-python-libraries

github.com/wdm0006Testing & quality109107 installsUpdated 2d ago
Repository

About reviewing-python-libraries

A review skill for assessing Python libraries across code structure, packaging, tests, security, documentation, API design, and CI/CD. It includes quick checks, red and green flags, and a report template for library evaluations.

Key features

  1. 01Checks for project structure and packaging
  2. 02Reviews tests and coverage
  3. 03Assesses security and dependencies
  4. 04Checks documentation and API design
  5. 05Evaluates CI/CD practices
  6. 06Provides a review report template

Use cases

  1. 01Performing an initial library health check
  2. 02Assessing a package before adopting it
  3. 03Identifying maintenance and security risks
  4. 04Writing a structured library review

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/wdm0006/python-skills --skill reviewing-python-libraries

After installing, type/reviewing-python-librariesin Claude Code to confirm it loaded.

Bundled filesCHECKLIST.mdREPORT_TEMPLATE.md

Details

From the project README

Python Library Review

Quick Health Check (5 min)

git clone https://github.com/user/package && cd package
head -50 pyproject.toml                     # Modern config?
ls tests/ && uv run pytest --collect-only   # Tests exist?
uv run pytest --cov=package | tail -20      # Coverage?
uvx bandit -r src/                          # Security?

Review Dimensions

AreaCheck For
Structuresrc/ layout, py.typed marker
Packagingpyproject.toml (not setup.py)
CodeType hints, docstrings, no anti-patterns
Tests80%+ coverage, edge cases
SecurityNo secrets, input validation, pip-audit clean
DocsREADME, API docs, changelog
APIConsistent naming, sensible defaults
CI/CDTests on PR, multi-Python, security scans

Red Flags 🚩

  • No tests
  • No type hints
  • setup.py only (no pyproject.toml)
  • Pinned exact versions for all deps
  • No LICENSE file
  • Last commit > 1 year ago

Green Flags ✅

  • Active maintenance (recent commits)
  • High test coverage (>85%)
  • Comprehensive CI/CD
  • Type hints throughout
  • Clear documentation
  • Semantic versioning

Report Template

# Library Review: [package]

**Rating:** [Excellent/Good/Needs Work/Significant Issues]

## Strengths
- [Strength 1]

## Areas for Improvement
- [Issue 1] - Severity: High/Medium/Low

## Category Scores
| Category | Score |
|----------|-------|
| Structure | ⭐⭐⭐⭐⭐ |
| Testing | ⭐⭐⭐☆☆ |
| Security | ⭐⭐⭐⭐☆ |

## Recommendations
1. [High priority action]
2. [Medium priority action]

For detailed checklists, see:

Best Practices Checklist

Essential:
- [ ] pyproject.toml valid
- [ ] Tests exist and pass
- [ ] README has install/usage
- [ ] LICENSE present
- [ ] No hardcoded secrets

Important:
- [ ] Type hints on public API
- [ ] CI runs tests on PRs
- [ ] Coverage > 85%
- [ ] Changelog maintained

Recommended:
- [ ] src/ layout
- [ ] py.typed marker
- [ ] Security scanning in CI
- [ ] Contributing guide

Learn More

This skill is based on the Guide to Developing High-Quality Python Libraries by Will McGinnis. The review criteria in this skill draw from all posts in the guide — see the full guide for detailed quality criteria across every dimension of library development.

Comments

Markdown supported