Pypi package display uses the src/README.md file update pyproject.toml appropriately.#1176
Merged
Conversation
sei-vsarvepalli
requested review from
ahouseholder and
cgyarbrough
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the package metadata so the PyPI long description is sourced from the Markdown file under src/, aligning the published project page with the desired README content.
Changes:
- Update
[project].readmeinpyproject.tomlto point tosrc/README.md(instead of the repository-rootREADME.md).
ahouseholder
approved these changes
Jun 11, 2026
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
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.
The pyproject.toml the line
readme = {file="README.md", content-type="text/markdown"}should change to
readme = {file="src/README.md", content-type="text/markdown"}so pypi page can have the README.md in src/ folder. Currently pypi branch has it own tags with strftime
+%Y.%-m.%-d%H%Mfor version control adhering to semver calver like rules.