fix(python): POWER-5106 add readme and project urls to PyPI metadata - #141
Merged
Merged
Conversation
The PyPI project page showed "no project description provided" because the package metadata declared no readme. Embed python/README.md as the long description and add Homepage/Documentation/Repository/Changelog URLs for the PyPI sidebar. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Fixes the empty project description on https://pypi.org/project/heimdallpower-api-client/ by declaring python/README.md as the package readme in pyproject.toml, and adds Homepage/Documentation/Repository/Changelog project URLs for the PyPI sidebar. Also rewords the README opening line so it reads naturally as a PyPI landing page. Verified locally: the built wheel's METADATA embeds the readme (text/markdown) and all four Project-URL entries; poetry check --lock passes.
Jira
Ticket: POWER-5106
AI usage (required)