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

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

The files mentions above (README, Code of Conduct, license file, etc) are used as a measure of package community health on many online platforms. Below, you can see an example how GitHub evaluates community health. This community health link is available for all GitHub repositories.

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

Snyk is another well-known company that keeps tabs on package health. Below you can see a similar evaluation of files in the GitHub repo as a measure of community health.

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