All skills
wdm0006 avatar

/library-review

@04f39a5

Comprehensively reviews Python libraries for quality across project structure, packaging, code quality, testing, security, documentation, API design, and CI/CD. Provides actionable feedback and improvement recommendations. Use when evaluating library health, preparing for major releases, or auditing dependencies.

  • 3 files
  • 12.1 KB
  • Updated 3 months ago
  • GitHub

Use this Skill: https://skilld.dev/gh/wdm0006/python-skills/library-review

This session only. Nothing lands on disk.

SKILL.md

≈83 tokens always: the name and description. ≈654 when used: this file. ≈2.4k more on demand in 2 files.

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

Area Check For
Structure src/ layout, py.typed marker
Packaging pyproject.toml (not setup.py)
Code Type hints, docstrings, no anti-patterns
Tests 80%+ coverage, edge cases
Security No secrets, input validation, pip-audit clean
Docs README, API docs, changelog
API Consistent naming, sensible defaults
CI/CD Tests 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.

Source: SKILL.md on GitHub

No third-party reports yet.

Signed by skilld at 04f39a5. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 weeks ago.

Activeupdated 3 months ago

README badge

README badge for wdm0006/python-skills/library-review