PEP 819: JSON Package Metadata

[emmatyping]

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
• 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

• PEP topic discussed in a suitable venue with general agreement that a PEP is appropriate
• Suggested sections included (unless not applicable)
  • Motivation
  • Rationale
  • Specification
  • Backwards Compatibility
  • Security Implications
  • How to Teach This
  • Reference Implementation
  • Rejected Ideas
  • Open Issues
• Python-Version set to valid (pre-beta) future Python version, if relevant
• Any project stated in the PEP as supporting/endorsing/benefiting from the PEP formally confirmed such
• Right before or after initial merging, PEP discussion thread created and linked to in Discussions-To and Post-History

---

📚 Documentation preview 📚: https://pep-previews--4751.org.readthedocs.build/pep-0819/

[DEKHTIARJonathan]

Let's GO 🚀 !

[AA-Turner]

Mostly minor suggestions:

One point I don't believe I saw covered is installed package metadata - I imagine the PEP should just call for copying the METADATA.json file if present in the binary distribution.

Thanks,
Adam

[AA-Turner]

This seems circular?

[emmatyping]

Ah, perhaps the first sentence is unclear. METADATA.json is still optional (since older packages may not have it), so if it does exist it should go at the root of the sources. The second sentence would probably be much better written as "Tools MUST NOT assume the METADATA.json file exists in source distributions."

[emmatyping]

Okay, rewrote this paragraph, hopefully much clearer!

[emmatyping]

One point I don't believe I saw covered is installed package metadata - I imagine the PEP should just call for copying the METADATA.json file if present in the binary distribution.

Good point!