Dynamic readme value generation #373
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves generating the
readmeattribute for a package:readmeinto the[project]section with the readme file name. This is what's happened so far.[tool.setuptools.dynamic]section so both get used. This is similar to what most packages did with thelong_descriptionsetting insetup.py.The PR does not attempt to parse previously used file names out of the
long_descriptionvalue because the format is undefined, every package did it slightly differently. It just assumes that maintainers want to concatenate the readme and the change log as content for the PyPI project page.If the package did something entirely different it is up to the script user and/or the PR reviewers to catch the difference and correct that manually.