Skip to content

pypi: import Name Retention Policy from PEP 541 #41

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

woodruffw
Copy link
Member

Hi all!

This is my attempt to copy another piece of PyPI policy into the policies website.

What I've done here is take PEP 541 and copy it mostly verbatim into the MkDocs site. The only changes I've made are:

  1. I've removed the non-policy parts of the PEP (i.e. the procedurally required sections that aren't part of the PEP's policy specification). I figured that this is easier to read/follow than having PEP-isms in the policy page here.

  2. I've preserved all links exactly as they were, but turned them all into direct links instead of footnote links. This is a slightly change from the PEP, where a mix is used.

Apart from those changes, the language of the policy should be exactly as it appears in PEP 541. However, it'd be good for someone to go over it with a fine-toothed comb to ensure I didn't make any formatting errors during conversion to Markdown.

CC @ewdurbin @miketheman

xref pypi/warehouse#17999 for context 🙂

Signed-off-by: William Woodruff <william@trailofbits.com>
@woodruffw
Copy link
Member Author

(NB: If/when this is merged, I'll also make a PR to the PEPs repo providing an appropriate "living spec" or similar link from PEP 541 to this page, similar to what the packaging PEPs do with PyPUG.)

Copy link
Member

@miketheman miketheman left a comment

Choose a reason for hiding this comment

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

I'm in favor of adopting this language into the policies page.

@ewdurbin is there a reason we should not merge this?

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.

2 participants