I do not mean to overcomplicate this, but I ran into some questions regarding how to handle this issue.

The only nice way to get the README (or long_description) is to run setup.py —long-description. There does not seem to be a good way to get the content type (rst/md), however, or the file name of the README.

I could parse those from the setup.cfg ini file, if it existed everywhere. But it does not in:

opentelemetry-python/docs/examples/opentelemetry-example-app
opentelemetry-python/opentelemetry-api
opentelemetry-python/opentelemetry-sdk

Are there conventions so that I can just assume that all long descriptions are in rst format? Or even that these are saved in a README.rst file so that I can read them directly from that file and complain if it does not exist? Codifying such a convention would be the easiest solution.

Edit: testutil is the only distribution without a README.rst at the moment but is not being pushed. (It might even be deleted? #374 5., point 4)

It might also be possible to just use ini files for the above packages, but paths with a pyproject.toml file are also returned as targets. Is there a possibility that pyproject.toml might be used instead of setup.py and setup.cfg in the future?

Test for package README syntax errors #445

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions