Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve pypi packages metadata #4362

Closed
gizero opened this issue Dec 17, 2024 · 3 comments · Fixed by #4363
Closed

Improve pypi packages metadata #4362

gizero opened this issue Dec 17, 2024 · 3 comments · Fixed by #4363

Comments

@gizero
Copy link
Contributor

gizero commented Dec 17, 2024

Is your feature request related to a problem?

While trying to add opentelemetry-python to the list of well known monorepos in renovate (a prominent automatic dependency update tool you might have heard of) to help grouping related upgrades, I noticed that their datasource for pypi leverages well known Package URLs from metadata to group packages being released from the same monorepo (here is a link to how they parse packages metadata). On the other hand I see that packages being released from opentelemetry-python repository all have a different homepage package url, pointing to their source subfolder within the repo.

Describe the solution you'd like

I'm suggesting to add to all released packages pyproject.tomls an extra package_url label, namely Repository, with value being the opentelemetry-python repo root url (https://github.com/open-telemetry/opentelemetry-python). This will appear close to the Homepage link on Pypi package pages and will be returned by the Pypi JSON api as part of the package's metadata. That would help renovate (once support for the opentelemetry-python monorepo will be added) to suggest upgrading all relevant packages in a single PR, with no need for custom rules to have them grouped.

Describe alternatives you've considered

No response

Additional Context

No response

Would you like to implement a fix?

Yes

@aabmass
Copy link
Member

aabmass commented Dec 17, 2024

It seems like "source" is the canonical label for this https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-project-urls and "repository" is an alias.

That said, "repository" is also much more common on Github than "source":

Repository seems reasonable to me 👍

@xrmx
Copy link
Contributor

xrmx commented Dec 18, 2024

@gizero While you are it are you going to do the same for -contrib too?

@gizero
Copy link
Contributor Author

gizero commented Dec 18, 2024

See open-telemetry/opentelemetry-python-contrib#3119 for the corresponding change on -contrib repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants