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

PEP 771: Default Extras for Python Software Packages #4198

Merged
merged 15 commits into from
Jan 22, 2025

Conversation

astrofrog
Copy link
Contributor

@astrofrog astrofrog commented Jan 13, 2025

Basic requirements (all PEP Types)

  • Read and followed PEP 1 & PEP 12
  • File created from the latest PEP template
  • PEP has next available number, & set in filename (pep-NNNN.rst), PR title (PEP 123: <Title of PEP>) and PEP header
  • Title clearly, accurately and concisely describes the content in 79 characters or less
  • Core dev/PEP editor listed as Author or Sponsor, and formally confirmed their approval
  • Author, Status (Draft), Type and Created headers filled out correctly
  • PEP-Delegate, Topic, Requires and Replaces headers completed if appropriate
    • Not needed
  • Required sections included
    • Abstract (first section)
    • Copyright (last section; exact wording from template required)
  • Code is well-formatted (PEP 7/PEP 8) and is in code blocks, with the right lexer names if non-Python
  • PEP builds with no warnings, pre-commit checks pass and content displays as intended in the rendered HTML
  • Authors/sponsor added to .github/CODEOWNERS for the PEP

Standards Track requirements

Question for PEP editors: there are some gaps in the PEP numbering, so is this the correct number to pick? I'm happy to update this if not.


📚 Documentation preview 📚: https://pep-previews--4198.org.readthedocs.build/pep-0771/

@astrofrog astrofrog requested a review from a team as a code owner January 13, 2025 15:03

This comment was marked as resolved.

@astrofrog astrofrog changed the title PEP 790: Default Extras for Python Software Packages PEP 771: Default Extras for Python Software Packages Jan 13, 2025
@hugovk hugovk added the new-pep A new draft PEP submitted for initial review label Jan 13, 2025
@hugovk

This comment was marked as resolved.

@astrofrog

This comment was marked as resolved.

@pradyunsg
Copy link
Member

pradyunsg commented Jan 13, 2025

I confirm that I am sponsoring this PEP.

Copy link
Member

@warsaw warsaw left a comment

Choose a reason for hiding this comment

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

Very nice PEP! LGTM in general although I have included some comments and suggestions.

@astrofrog
Copy link
Contributor Author

@warsaw - thanks for the review! I've now pushed changes to address your comments.

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thanks for writing this up! It sounds useful.

@astrofrog
Copy link
Contributor Author

astrofrog commented Jan 15, 2025

@warsaw - thank you for the review! I believe I have implemented all your comments.

In addition, I have pushed a change to the reference implementation section to update links there, as the work on this implementation is now fully functional.

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 few small typos

@astrofrog
Copy link
Contributor Author

@di @pfmoore - thanks for the comments! These should be fixed now :)

@astrofrog

This comment was marked as outdated.

@astrofrog
Copy link
Contributor Author

astrofrog commented Jan 22, 2025

Following a suggestion by @pradyunsg, it might be easiest to no longer make any substantive updates to this PR, and instead publish it once/if the PEP editors feel it is ready. Once it is published, I will shortly after open a PR which makes some changes/additions based on the discussion in this thread:

https://discuss.python.org/t/pre-publish-pep-711-default-extras-for-python-software-packages/77892

It will then be easier to review these changes rather than having to re-read the whole PEP, which is getting long.

And once that follow-up PR is merged, we can open the main discussion thread for the PEP.

astrofrog and others added 4 commits January 22, 2025 09:51
@astrofrog
Copy link
Contributor Author

I have rebased due to a conflict in CODEOWNERS but have not made any changes since my last comment.

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thanks for the update! Looks good editorially, let's merge later today if there's no last minute suggestions from others.


PS Generally we try and avoid force-pushing, it's easier to review what's changed with normal pushes, and everything will be squash-merged to a single commit at the end anyway.

Another tip: please avoid putting @usernames in commit messages, GitHub can be quite annoying and end up pinging several times from other forks :)

@astrofrog
Copy link
Contributor Author

@hugovk oops, sorry about the force push, there was a conflict and I am used to rebasing in this case for other projects.

@hugovk
Copy link
Member

hugovk commented Jan 22, 2025

Thank you!

Next, please post to discuss.python.org, then open a quick PR to put that URL in Discussions-To and Post-History.

@hugovk hugovk merged commit 0ff88ad into python:main Jan 22, 2025
5 checks passed
@astrofrog
Copy link
Contributor Author

astrofrog commented Jan 22, 2025

@hugovk - thanks for merging! As mentioned in #4198 (comment) I'd like to make a follow-up PR with a few key changes based on the pre-publish discuss thread, and only once that is merged open the main discussion thread. Would that be ok? (I plan to open up the follow-up PR this evening or tomorrow morning)

@AA-Turner
Copy link
Member

This seems fine, there's no rush to open the next Discussions-To thread -- perhaps you could include the updates to Post-History and Discussions-To in the follow-up PR you plan on opening (just before that one is merged)

A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-pep A new draft PEP submitted for initial review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants