Skip to content

MAINT Add project.urls to pyproject.toml #28761

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.

Sign up for GitHub

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

Jump to bottom
Merged
jeremiedbb merged 3 commits into from
Apr 4, 2024
Merged

MAINT Add project.urls to pyproject.toml #28761

jeremiedbb merged 3 commits into from
Apr 4, 2024

Conversation

@lesteve
Copy link
Member

@lesteve lesteve commented Apr 3, 2024 •
edited
Loading

This adds some metadata that are in the current sdist generated in setup.py and are not there anymore with Meson.

In the comparison done in #28757 (comment), the only meaningful difference is in PKG-INFO.

After reordering2 the diff is like this:

--- PKG-INFO-setup-reordered	2024-04-03 16:02:02.434567837 +0200
+++ PKG-INFO-meson	2024-04-03 15:20:17.792383000 +0200
@@ -2,10 +2,6 @@
 Name: scikit-learn
 Version: 1.5.dev0
 Summary: A set of python modules for machine learning and data mining
-Home-page: https://scikit-learn.org
-Download-URL: https://pypi.org/project/scikit-learn/#files
-Maintainer: Andreas Mueller
-Maintainer-email: [email protected]
 License: new BSD
 Classifier: Intended Audience :: Science/Research
 Classifier: Intended Audience :: Developers
@@ -27,7 +23,6 @@
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.9
-License-File: COPYING
 Requires-Dist: numpy>=1.19.5
 Requires-Dist: scipy>=1.6.0
 Requires-Dist: joblib>=1.2.0

I think Maintainer does not make too much sense and Andy's email is probably not valid anymore.

I added project.urls that are used for the "Project links" on PyPI left-hand-side panel. See for example for numpy:
https://github.com/numpy/numpy/blob/ffb23cd626bc1f7d09aed257e28142346661a915/pyproject.toml#L54-L60

https://pypi.org/project/numpy/
image

Comments:

@github-actions
Copy link

github-actions bot commented Apr 3, 2024 •
edited
Loading

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: 49337f7. Link to the linter CI: here

@lesteve lesteve mentioned this pull request Apr 3, 2024
Merged
betatim
betatim approved these changes Apr 4, 2024
View reviewed changes
Copy link
Member

@betatim betatim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine for me.

Should we make a note somewhere to check the links on PyPI when we make a rc0 before a real release?

@lesteve
Copy link
Member Author

lesteve commented Apr 4, 2024

Should we make a note somewhere to check the links on PyPI when we make a rc0 before a real release?

Not sure, I guess these links are not super likely to change? Maybe the changelog URL is the one that is more likely to change and I would be fine removing it.

@lesteve
Copy link
Member Author

lesteve commented Apr 4, 2024

Having said this, I am completely fine adding "check the links" somewhere in the check-list of the maintainer docs though

@betatim
Copy link
Member

betatim commented Apr 4, 2024

I wasn't thinking that they'd change, more that we should check for the first release made using meson + information from pyproject.toml we should check that it worked (aka that PyPI still has the links instead of empty values/missing links).

@lesteve
Copy link
Member Author

lesteve commented Apr 4, 2024 •
edited
Loading

OK got you, I tested this quickly on test.pypi.org here is the rendering on 5b9fb3a: https://test.pypi.org/project/sklearn/1.5.dev1/ which seems fine.

It seems mostly fine except that the order is alphabetical on pypi.org, I am not sure whether there is a way to tweak this ... there is certainly no mention of "ordering" in PEP 621 and I guess it is up to pypi.org to decide which order to use for the "project links".

Edit: I found pypi/warehouse#3097 (comment) which seems to agree that there is little control of the display ordering on pypi.org ...

@lesteve
Copy link
Member Author

lesteve commented Apr 4, 2024

To make @jeremiedbb happy I put back maintainers and followed what numpy does:

  • name: scikit-learn developers
  • email: scikit-learn mailing list

thomasjpfan
thomasjpfan approved these changes Apr 4, 2024
View reviewed changes
Copy link
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

jeremiedbb
jeremiedbb approved these changes Apr 4, 2024
View reviewed changes
Copy link
Member

@jeremiedbb jeremiedbb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jeremiedbb jeremiedbb enabled auto-merge (squash) April 4, 2024 13:43
@jeremiedbb jeremiedbb merged commit 60dd8e3 into scikit-learn:main Apr 4, 2024
@lesteve lesteve deleted the add-pyproject-project-urls branch April 4, 2024 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@betatim betatim betatim approved these changes

@thomasjpfan thomasjpfan thomasjpfan approved these changes

@jeremiedbb jeremiedbb jeremiedbb approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@lesteve @betatim @thomasjpfan @jeremiedbb