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.

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

Assorted tweaks to pyproject.toml #475

Merged
merged 4 commits into from
Sep 4, 2023
Merged

Assorted tweaks to pyproject.toml #475

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
407b49e
BUILD: drop dev dependency on auditwheel
dnicolodi Sep 2, 2023
4456eba
BUILD: update maintainers
dnicolodi Sep 2, 2023
9298373
BUILD: tweak classifiers
dnicolodi Sep 2, 2023
d3ce933
DOC: about: extend credits
dnicolodi Sep 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,11 @@ readme = 'README.rst'
requires-python = '>= 3.7'
license = { file = 'LICENSES/MIT.txt' }
keywords = ['meson', 'build', 'backend', 'pep517', 'package']
authors = [
{ name = 'Filipe Laíns', email = 'lains@riseup.net' },
dnicolodi marked this conversation as resolved.
Show resolved Hide resolved
maintainers = [
{ name = 'Ralf Gommers ', email = 'ralf.gommers@gmail.com' },
{ name = 'Daniele Nicolodi', email = 'daniele@grinta.net' },
{ name = 'Henry Schreiner', email = 'HenrySchreinerIII@gmail.com' },
{ name = 'Thomas Li'},
Copy link
Member Author

Choose a reason for hiding this comment

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

PyPI makes a mess of this. It shows Thomas as the only maintainer but links his name to Ralf's email.

Also the license appears again in a funny way, it now displays the first lines of LICENSES/MIT.txt

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, not sure what's up with the maintainers field. Possibly because email for Thomas is missing? I didn't notice that before. If that doesn't fix it, I guess we should remove this change for now.

License looks as expected to me. PyPI fixed the problem where that full license text would horribly overflow. It's much better than it was before. Of course, even better would be to finish and implement PEP 639, so we can see the SPDX classifier ....

Copy link
Member Author

@dnicolodi dnicolodi Sep 5, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

The PyPI page says "Maintaner" singular, thus I'm not sure PyPI has support for multiple maintainers listed in the package metadata. It is a bit annoying that the package metadata specification and the main cunsumer of it are so out of sync. I thought that the license field was fixed doing something like what Github does: match the license text and provide a short license identifier. I must have dreamed of this.

Copy link
Contributor

Choose a reason for hiding this comment

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

Re maintainers: maybe we should just comment it out now and list "The meson-python maintainers"? We have a full list in the docs already.

I thought that the license field was fixed doing something like what Github does: match the license text and provide a short license identifier. I must have dreamed of this.

There's some setuptools-specific old way of doing this I believe, taking it from classifiers if the license field under [project] isn't used. Deleting a standardized PEP 621 entry to go back to something undocumented doesn't seem quite right though, so I have this one filed under "revisit when PEP 639 is done".

Copy link
Member Author

Choose a reason for hiding this comment

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

Re maintainers: maybe we should just comment it out now and list "The meson-python maintainers"? We have a full list in the docs already.

Sure. I listed the names because I thought that having an entity there with an associated email address may be useful. PyPI lists you as a maintainer, I guess because your user is associated with the project. I'm fine having just you listed as a maintainer in the metadata.

There's some setuptools-specific old way of doing this I believe, taking it from classifiers if the license field under [project] isn't used. Deleting a standardized PEP 621 entry to go back to something undocumented doesn't seem quite right though, so I have this one filed under "revisit when PEP 639 is done".

Yes, indeed. Let's keep things as they are for now.

Copy link
Member Author

Choose a reason for hiding this comment

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

Uhm. The way PyPI reports the maintainers list may be due to how we generate the metadata. This is how the metadata fields related to the maintainers look like:

Maintainer: Thomas Li
Maintainer-Email: Ralf Gommers  <ralf.gommers@gmail.com>, Daniele Nicolodi <daniele@grinta.net>, Henry Schreiner <HenrySchrein

I'm verifying what the specification prescribes, but at a first look that seems wrong.

Copy link
Member Author

Choose a reason for hiding this comment

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

At least the Maintainer-Email field is wrong, as it is supposed to be an RFC-822 From header compliant format https://packaging.python.org/en/latest/specifications/core-metadata/#maintainer-email The specification does not specify how multiple maintainers should be listed

Copy link
Member Author

Choose a reason for hiding this comment

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

Lovely, the specification for pyproject.toml contradicts the specification for the metadata file https://packaging.python.org/en/latest/specifications/declaring-project-metadata/#authors-maintainers

]
classifiers = [
'Development Status :: 4 - Beta',
dnicolodi marked this conversation as resolved.
Show resolved Hide resolved
Expand Down