mcpField
R
reviewing-python-libraries

reviewing-python-libraries

github.com/wdm0006テスト・品質109107 回インストール2 日前に更新
リポジトリ

reviewing-python-libraries について

Python ライブラリをコード構成、パッケージング、テスト、セキュリティ、ドキュメント、API 設計、CI/CD の観点から評価するスキルです。初期確認項目、注意点と評価の目安、レビュー報告テンプレートを含みます。

主な機能

  1. 01プロジェクト構成とパッケージングの確認
  2. 02テストとカバレッジのレビュー
  3. 03セキュリティと依存関係の評価
  4. 04ドキュメントと API 設計の確認
  5. 05CI/CD の実践状況の評価
  6. 06レビュー報告テンプレート

活用シーン

  1. 01ライブラリの初期状態の確認
  2. 02パッケージ採用前の評価
  3. 03保守性とセキュリティリスクの特定
  4. 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/CDPR でのテスト、複数の 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]

詳細なチェックリストについては、以下を参照してください。

ベストプラクティスチェックリスト

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 ライブラリを開発するためのガイド に基づいています。このスキルのレビュー基準は、ガイド内のすべての記事を参考にしています。ライブラリ開発のあらゆる項目に関する詳細な品質基準については、ガイド全文 をご覧ください。

コメント