setup.py: add long_description #1073
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
twine (the tool we use to upload packages to PyPI) is currently failing if the long_description (used to render a project's page on PyPI website) is not set. Somehow it complains that it is not well formatted reStructuredText, but it's simply empty... This looks like a bug, or bad interaction between twince and setuptools, because the field is technically optional. Also see pypa/twine#960 and pypa/twine#908. This issue is currently preventing the upload of newly built Brotli v1.1.0 Python wheels to PyPI: google/brotli-wheels#18 (comment) Anyway, we may well set the long_description to the content of the README.md file, as it's customary for python projects.
|
Awesome. Thanks. |
eustas
approved these changes
Sep 7, 2023
anthrotype
added a commit
to google/brotli-wheels
that referenced
this pull request
Sep 7, 2023
fixes issue with twine complaining about invalid long_description
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
twine (the tool we use to upload packages to PyPI) is currently failing if the long_description (used to render a project's page on PyPI website) is not set. Somehow it complains that it is not well formatted reStructuredText, but it's simply empty... This looks like a bug, or bad interaction between twince and setuptools, because the field is technically optional. Also see pypa/twine#960 and pypa/twine#908.
This issue is currently preventing the upload of newly built Brotli v1.1.0 Python wheels to PyPI: google/brotli-wheels#18 (comment)
Anyway, we may well set the long_description to the content of the README.md file, as it's customary for python projects.