Pythonパッケージリポジトリにあるべきドキュメントファイル

Python パッケージングガイドのこのセクションでは、Python パッケージリポジトリにあるべきすべてのファイルをレビューします。 Python パッケージには最低限以下のファイルが必要です:

上で言及したファイル（README、行動規範、ライセンスファイルなど）は、多くのオンラインプラットフォームでパッケージコミュニティの健全性を測る尺度として使われています。 以下に、GitHubがコミュニティの健全性をどのように評価しているかの例を示します。 このコミュニティ健全性リンクは、すべての GitHub リポジトリで利用できます。

GitHub community health は、リポジトリのコミュニティレベルの健全性を評価する際に、他の要素の中から readme ファイルを探します。この例は、 MovingPandas GitHub repo (2022年11月23日撮影のスクリーンショット) からのものです。

Snyk もパッケージの健全性を監視している有名な会社です。 以下では、コミュニティの健全性を測る尺度として、GitHub リポジトリ内のファイルに対する同様の評価を見ることができます。

SNYK パッケージの健全性を示すスクリーンショット。 両方のプラットフォームがREADMEファイルを探していることに注目してください。 (スクリーンショットは2022年11月23日撮影) 。