Skip to content

Conversation

@woodruffw
Copy link
Member

@woodruffw woodruffw commented Oct 11, 2024

This is a first blush at updating the packaging specifications for PEP 753, now that it's been accepted.

Key changes:

  1. Home-page and Download-URL have been marked as deprecated and moved into the deprecated section of the metadata spec.
  2. well-known-project-urls.rst has been added to reflect the core spec/recommendations in PEP 753.
  3. Cross-referenced/linked between the spec above and a bunch of pages that touch on project URL handling.

(2) reflects the core spec part of the PEP, but I've tweaked the language to make it less "PEP-y" based on how the other PyPA living specs seem to be written. But I'm happy to restructure/rewrite it however others please!

Related tasks that I still need to do:

  • Update PyPI's metadata handling to match PEP 753 (the current behavior is virtually identical, but there are some edge cases + I'll add appropriate tests)
  • Update PyPI's documentation to reference PEP 753
  • Other, higher-level guides/docs that should be updated?
  • Update the PEP itself to point to the canonical living PyPA spec PEP 753: link to PyPA spec python/peps#4095

CC @pfmoore @ncoghlan @di as interested parties 🙂


📚 Documentation preview 📚: https://python-packaging-user-guide--1611.org.readthedocs.build/en/1611/

Copy link
Member

@pfmoore pfmoore left a comment

Choose a reason for hiding this comment

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

A couple of minor comments, but overall LGTM!

woodruffw and others added 4 commits October 11, 2024 15:03
Signed-off-by: William Woodruff <[email protected]>
This reverts commit 5a6c37d.
@woodruffw
Copy link
Member Author

CI failure looks unrelated (linkcheck seems to be failing due to the current Internet Archive outage).

Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

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

A few small edits. Thanks @woodruffw.

@woodruffw
Copy link
Member Author

CI appears to have righted itself, so this should be good to go!

@woodruffw
Copy link
Member Author

Gentle ping for review!

@pfmoore
Copy link
Member

pfmoore commented Oct 28, 2024

You have 2 approvals, I think this is ready to go. I can hit the merge button, apparently, but I'm not really an active committer to this repo, so I think it should be one of the guide editors who merges it.

Copy link
Member

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

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

Thanks!

@webknjaz webknjaz added this pull request to the merge queue Oct 30, 2024
Merged via the queue into pypa:main with commit 696e136 Oct 30, 2024
5 checks passed
@woodruffw woodruffw deleted the ww/pep-753 branch October 30, 2024 00:56
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.

4 participants