Repository files navigation

The PEPs in this repo are published automatically on the web athttps://peps.python.org/. To learn more about the purpose of PEPs and how to goabout writing one, please start reading atPEP 1. Note that the PEP Index(PEP 0) is automatically generated based on the metadata headers in other PEPs.

The canonical form of PEP links are zero-padded, such ashttps://peps.python.org/pep-0008/.

Shortcut redirects are also available.For example,https://peps.python.org/8 redirects to the canonical link.

See theContributing Guidelines.

Please don't commit changes with reStructuredText syntax errors that cause PEPgeneration to fail, or result in major rendering defects relative to what youintend.

For every PR, we automatically create a preview of the rendered PEPs usingRead the Docs.You can find it in the merge box at the bottom of the PR page:

1. Click "Show all checks" to expand the checks section
2. Find the line fordocs/readthedocs.org:pep-previews
3. Click on "Details" to the right

See thebuild documentation for fullinstructions on how to render PEPs locally.In summary, run the following in a fresh, activated virtual environment:

# Install requirementspython -m pip install -U -r requirements.txt# Build the PEPsmake html# Or, if you don't have 'make':python build.py

The output HTML is found under thebuild directory.

You can check for and fix common linting and spelling issues,either on-demand or automatically as you commit, with our pre-commit suite.See theContributing Guide for details.