Documentation Files That Should be in your Python Package Repository#
In this section of the Python packaging guide, we review all of the files that you should have in your Python package repository. Your Python package should, at a minimum have the following files:
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.
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.