reviewing-python-libraries について
Python ライブラリをコード構成、パッケージング、テスト、セキュリティ、ドキュメント、API 設計、CI/CD の観点から評価するスキルです。初期確認項目、注意点と評価の目安、レビュー報告テンプレートを含みます。
主な機能
- 01プロジェクト構成とパッケージングの確認
- 02テストとカバレッジのレビュー
- 03セキュリティと依存関係の評価
- 04ドキュメントと API 設計の確認
- 05CI/CD の実践状況の評価
- 06レビュー報告テンプレート
活用シーン
- 01ライブラリの初期状態の確認
- 02パッケージ採用前の評価
- 03保守性とセキュリティリスクの特定
- 04構造化されたライブラリレビューの作成
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ wdm0006/ python-skills --skill reviewing-python-librariesインストール後、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 ではない) |
| コード | 型ヒント、docstring、アンチパターンがないこと |
| テスト | カバレッジ 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 対応