Add project urls metadata to pyproject.toml#617
Conversation
This will make them clickable as links on Pypi, and also to other consumers of 'Well-known Project URLs in Metadata' https://packaging.python.org/en/latest/specifications/well-known-project-urls/
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe project configuration adds repository, documentation, and release URLs under the project metadata. ChangesProject metadata
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #617 +/- ##
=======================================
Coverage 98.36% 98.36%
=======================================
Files 10 10
Lines 1220 1220
=======================================
Hits 1200 1200
Misses 20 20 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
Cool stuff---thanks for the contribution! |
Was looking at this project from Pypi, and was wishing it had clickable links to docs and repo in the Pypi sidebar like below, so thought I'd open the PR to add it:
Adding as PEP-621 supported project metadata - documented here:
'Repository' and 'Documentation' in particular are 'well-known labels'. Releases isn't, but I saw UV using it and thought it applied here - I'll leave to your judgement, happy to remove that if unwanted.
This will create clickable sidebar links on Pypi as in the screenshot above, and be usable by other consumers of 'Well-known Project URLs in Metadata' https://packaging.python.org/en/latest/specifications/well-known-project-urls/
Summary by CodeRabbit