[CHORE](packaging) Publish package READMEs as PyPI project descriptions - #735
Merged
Merged
Conversation
overture-schema-pyspark, overture-schema-codegen, and overture-schema-common each ship a README that never reaches the distribution metadata: their pyproject.toml files omit `readme`, so the built wheels and sdists carry an empty Description and the PyPI pages render only the one-line summary. pyspark and codegen also lacked `maintainers` and `[project.urls]`, leaving their PyPI pages without Homepage, Source, or Issues links. The other ten packages under packages/ declare all three fields. Refs #734 Signed-off-by: Seth Fitzsimmons <seth@mojodna.net>
🗺️ Schema reference docs preview is live!
Note ♻️ This preview updates automatically with each push to this PR. |
John McCall (lowlydba)
approved these changes
Sep 11, 2026
John McCall (lowlydba)
left a comment
John McCall (lowlydba)
left a comment
Contributor
There was a problem hiding this comment.
LGTM! Nice cleanup - the ones w/out a README definitely look a bit sus when viewed on PyPI 😆
Roel Bollens (RoelBollens-TomTom)
approved these changes
Sep 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
3 participants
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.
Description
overture-schema-pyspark,overture-schema-codegen, andoverture-schema-commonpublish to PyPI with an empty project description. Each ships a README, but itspyproject.tomlomitsreadme = "README.md", so the README never reaches the distribution metadata and the PyPI page renders only the one-line summary.overture-schema-pysparkandoverture-schema-codegenalso omitmaintainersand[project.urls], leaving their PyPI pages without Homepage, Source, or Issues links.This adds the missing fields. The other ten packages under
packages/already declare all three.PyPI metadata is immutable per release, so each page fills in on that package's next version bump.
Closes #734
Reference
overture-schema-pysparkon PyPI, showing the empty descriptionTesting
uv buildfor each of the three packages, readingMETADATAout of the resulting wheel:Description-Content-TypeMaintainerProject-URLoverture-schema-pysparktext/markdownoverture-schema-codegentext/markdownoverture-schema-commontext/markdowntwine checkpasses on all three wheels and all three sdists.Checklist
Checklist of tasks commonly-associated with schema pull requests. Please review the relevant checklists and ensure you do all the tasks that are required for the change you made.
No schema change, so items 1-6 do not apply.
Abut is not intended to test propertyA's validity, and you made a schema change that invalidates propertyAin that counterexample, fix the counterexample to align it with your schema change.Documentation website
Docs preview for this PR.