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 691: Refactor based on Feedback #2592

Merged
merged 32 commits into from May 8, 2022
Merged

Conversation

dstufft
Copy link
Member

@dstufft dstufft commented May 8, 2022

  • Reorganize the content so we introduce things in a more gradual approach, first pulling in versioning, then the JSON serialization, then our content types, then finally tying it all together with content negotiation.
  • Expand a number of the sections with more detail.
  • Add ?format=<content-type> as an optional, alternative mechanism to using HTTP's conneg.
  • Explicitly mention that the decisions made here enable repositories to do an endpoint per content-type if they desire.
  • Add a recommendations section, to guide implementors on the best "default" choices.
  • Add FAQ entries for a number of questions:
    • Implications for static file servers
    • Does this mean that PyPI is dropping support for PEP 503.
    • Why TUF doesn't force us to have a single URL per TUF target.
    • Why we haven't added application/json in addition to text/html.
  • Support the PEP 629 metadata inside of the JSON responses and provide an area for any future data of that nature.
    • This required moving the /simple/ response into a sub key rather than a top level dictionary.
  • Add PyPI to the Appendix
  • Rename the dist-info-metadata-available field to dist-info-metadata.
    • Recommend that hashes for dist-info-metadata are provided if possible.
  • Change the semantics of dist-info-metadata and yanked slightly to make them match gpg-sig better and to make it easier to use them (remove the presence of the key being significant, make the value itself communicate all of the information).
  • Update the PEP-Delegate to be @brettcannon.

@dstufft dstufft merged commit 178afaf into python:main May 8, 2022
@AA-Turner
Copy link
Member

@dstufft please may you add the required copyright declaration? I believe Cam asked before - from an editorial perspective we require it, but can't propose it ourselves as we don't hold the copyright.

Thanks,
Adam

@dstufft
Copy link
Member Author

dstufft commented May 8, 2022

Didn't notice it wasn't there, give me a minute.

@dstufft
Copy link
Member Author

dstufft commented May 8, 2022

@AA-Turner #2593

@AA-Turner
Copy link
Member

Thanks!

A

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.

None yet

2 participants