Skip to content

Pypi description load from README#1057

Merged
mhucka merged 19 commits into
tensorflow:masterfrom
kenya-sk:pypi-description
May 12, 2026
Merged

Pypi description load from README#1057
mhucka merged 19 commits into
tensorflow:masterfrom
kenya-sk:pypi-description

Conversation

@kenya-sk
Copy link
Copy Markdown
Contributor

@kenya-sk kenya-sk commented Apr 27, 2026

Use the project README.md as the PyPI long description instead of the hardcoded module docstring in release/setup.py (Issue #1055 ).

Keep image paths in README.md relative for repository portability, and rewrite them to absolute GitHub raw URLs only when generating the PyPI long description so they continue to render correctly on PyPI.

@kenya-sk kenya-sk changed the title add: pypi description load from README pypi description load from README Apr 27, 2026
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates image URLs in README.md to absolute paths and modifies release/setup.py to dynamically load the long description from the README file. Feedback suggests refactoring setup.py to eliminate duplicated path resolution logic and recommends dynamically transforming relative image paths during the build process to maintain repository portability.

Comment thread release/setup.py Outdated
Comment thread README.md Outdated
@mhucka mhucka self-assigned this May 6, 2026
@mhucka mhucka changed the title pypi description load from README Pypi description load from README May 11, 2026
@kenya-sk
Copy link
Copy Markdown
Contributor Author

@mhucka
I confirmed that the CI was passing.
I would appreciate it if you could review it.

Copy link
Copy Markdown
Member

@mhucka mhucka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for working on this!

I think there may be a small error in which README.md file gets used. Also, I will do a quick PR to replace the relative path to the logo image in the top-level README.md file so that it's an absolute path, and this will avoid the need for the regex-based replacement implemented in this PR.

Comment thread release/build_pip_package.sh Outdated
Comment thread release/setup.py Outdated
Comment thread release/setup.py Outdated
@mhucka mhucka added the area/docs Involves documentation – problems, ideas, requests label May 12, 2026
Copy link
Copy Markdown
Member

@mhucka mhucka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mhucka mhucka added this pull request to the merge queue May 12, 2026
Merged via the queue into tensorflow:master with commit 21021f6 May 12, 2026
5 checks passed
@kenya-sk kenya-sk deleted the pypi-description branch May 13, 2026 01:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Involves documentation – problems, ideas, requests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants