Skip to content

Add project urls metadata to pyproject.toml#617

Merged
t-muser merged 1 commit into
bayesian-optimization:masterfrom
EFord36:patch-1
Jul 21, 2026
Merged

Add project urls metadata to pyproject.toml#617
t-muser merged 1 commit into
bayesian-optimization:masterfrom
EFord36:patch-1

Conversation

@EFord36

@EFord36 EFord36 commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

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:

Screenshot 2026-07-21 at 16 48 01

Adding as PEP-621 supported project metadata - documented here:

A list of URLs associated with your project, displayed on the left sidebar of your PyPI project page.

'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

  • Documentation
    • Added project links for the repository, documentation, and release information to the project metadata.

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/
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a517b8f9-6cc9-4e08-a696-41490bfb2247

📥 Commits

Reviewing files that changed from the base of the PR and between 17b259a and e713781.

📒 Files selected for processing (1)
  • pyproject.toml

📝 Walkthrough

Walkthrough

The project configuration adds repository, documentation, and release URLs under the project metadata.

Changes

Project metadata

Layer / File(s) Summary
Project URL declarations
pyproject.toml
Adds Repository, Documentation, and Releases entries to [project.urls].

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: phi-friday, t-muser

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding project URL metadata to pyproject.toml.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Jul 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.36%. Comparing base (17b259a) to head (e713781).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@t-muser

t-muser commented Jul 21, 2026

Copy link
Copy Markdown
Member

Cool stuff---thanks for the contribution!

@t-muser
t-muser merged commit 8b9a062 into bayesian-optimization:master Jul 21, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants