关于 reviewing-python-libraries
用于评估 Python 库的审查技能，涵盖代码结构、打包、测试、安全、文档、API 设计和 CI/CD。提供快速检查项、风险与优良信号，以及评审报告模板。
主要功能
- 01检查项目结构与打包方式
- 02审查测试与覆盖率
- 03评估安全性和依赖项
- 04检查文档与 API 设计
- 05评估 CI/CD 实践
- 06提供评审报告模板
适用场景
- 01快速检查库的健康状况
- 02评估是否采用某个包
- 03识别维护和安全风险
- 04撰写结构化库评审
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/reviewing-python-libraries确认已加载。
附带文件CHECKLIST.mdREPORT_TEMPLATE.md
详细介绍
Python 库审查
快速健康检查（5 分钟）
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?
审查维度
| 领域 | 检查内容 |
|---|---|
| 结构 | src/ 布局、py.typed 标记 |
| 打包 | pyproject.toml（而非 setup.py） |
| 代码 | 类型提示、文档字符串、无反模式 |
| 测试 | 覆盖率 80% 以上、边界情况 |
| 安全 | 无密钥、输入验证、pip-audit 检查通过 |
| 文档 | README、API 文档、更新日志 |
| API | 命名一致、默认值合理 |
| CI/CD | PR 上运行测试、多版本 Python、安全扫描 |
危险信号 🚩
- 没有测试
- 没有类型提示
- 仅有 setup.py（没有 pyproject.toml）
- 所有依赖项都固定为精确版本
- 没有 LICENSE 文件
- 上次提交距今超过 1 年
积极信号 ✅
- 积极维护（近期有提交）
- 测试覆盖率高（超过 85%）
- CI/CD 完善
- 全面使用类型提示
- 文档清晰
- 语义化版本控制
报告模板
# 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]
如需详细检查清单，请参阅：
- CHECKLIST.md - 完整审查清单
- REPORT_TEMPLATE.md - 完整报告模板
最佳实践检查清单
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
了解更多
本技能基于 Will McGinnis 编写的 Python 高质量库开发指南。本技能中的审查标准参考了该指南中的所有文章；有关库开发各个维度的详细质量标准，请参阅完整指南。
评论
支持 Markdown