diff options
| author | Cosimo Lupo <clupo@google.com> | 2023-09-07 10:28:09 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-07 11:28:09 +0200 |
| commit | 2ce85662c52a5057cc2e246949682c3fdaf99f5b (patch) | |
| tree | 42188cdc932836e314aafa384bae0feb979228e9 /setup.py | |
| parent | ed738e842d2fbdf2d6459e39267a633c4a9b2f5d (diff) | |
| download | brotli-2ce85662c52a5057cc2e246949682c3fdaf99f5b.zip brotli-2ce85662c52a5057cc2e246949682c3fdaf99f5b.tar.gz brotli-2ce85662c52a5057cc2e246949682c3fdaf99f5b.tar.bz2 | |
setup.py: add long_description (#1073)
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 https://github.com/pypa/twine/issues/960 and https://github.com/pypa/twine/issues/908.
This issue is currently preventing the upload of newly built Brotli v1.1.0 Python wheels to PyPI:
https://github.com/google/brotli-wheels/issues/18#issuecomment-1706910190
Anyway, we may well set the long_description to the content of the README.md file, as it's customary for python projects.
Diffstat (limited to 'setup.py')
| -rw-r--r-- | setup.py | 5 |
1 files changed, 5 insertions, 0 deletions
@@ -276,9 +276,14 @@ CMD_CLASS = { 'build_ext': BuildExt, } +with open("README.md", "r") as f: + README = f.read() + setup( name=NAME, description=DESCRIPTION, + long_description=README, + long_description_content_type="text/markdown", version=VERSION, url=URL, author=AUTHOR, |