[PR #1073] [MERGED] setup.py: add long_description #1626

New Issue

claunia · 2026-01-29T20:55:00Z

claunia commented

2026-01-29 20:55:00 +00:00

📋 Pull Request Information

Original PR: https://github.com/google/brotli/pull/1073
Author: @anthrotype
Created: 9/6/2023
Status: ✅ Merged
Merged: 9/7/2023
Merged by: @eustas

Base: master ← Head: py-long-description

📝 Commits (1)

4541387 setup.py: add long_description

📊 Changes

1 file changed (+5 additions, -0 deletions)

View changed files

📝 setup.py (+5 -0)

📄 Description

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.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/google/brotli/pull/1073 **Author:** [@anthrotype](https://github.com/anthrotype) **Created:** 9/6/2023 **Status:** ✅ Merged **Merged:** 9/7/2023 **Merged by:** [@eustas](https://github.com/eustas) **Base:** `master` ← **Head:** `py-long-description` --- ### 📝 Commits (1) - [`4541387`](https://github.com/google/brotli/commit/45413874748d1f92a7e701d7320efaa101441c20) setup.py: add long_description ### 📊 Changes **1 file changed** (+5 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `setup.py` (+5 -0) </details> ### 📄 Description 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. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

claunia added the pull-request label 2026-01-29 20:55:00 +00:00

claunia closed this issue

2026-01-29 20:55:01 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/brotli#1626