https://github.com/python/peps

Python Enhancement Proposals
https://github.com/python/peps

Last synced: 4 days ago
JSON representation

Python Enhancement Proposals

• Host: GitHub
• URL: https://github.com/python/peps
• Owner: python
• Created: 2013-10-08T13:27:12.000Z (about 11 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T10:47:21.000Z (about 2 months ago)
• Last Synced: 2024-10-29T10:57:05.715Z (about 2 months ago)
• Language: reStructuredText
• Homepage: https://peps.python.org
• Size: 28.6 MB
• Stars: 4,433
• Watchers: 264
• Forks: 1,524
• Open Issues: 49
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
Python Enhancement Proposals

============================

.. image:: https://github.com/python/peps/actions/workflows/render.yml/badge.svg

    :target: https://github.com/python/peps/actions

The PEPs in this repo are published automatically on the web at

https://peps.python.org/. To learn more about the purpose of PEPs and how to go

about writing one, please start reading at :pep:`1`. Note that the PEP Index

(:pep:`0`) is automatically generated based on the metadata headers in other PEPs.

Canonical links

===============

The canonical form of PEP links are zero-padded, such as

``https://peps.python.org/pep-0008/``.

Shortcut redirects are also available.

For example, ``https://peps.python.org/8`` redirects to the canonical link.

Contributing to PEPs

====================

See the `Contributing Guidelines <./CONTRIBUTING.rst>`_.

Checking PEP formatting and rendering

=====================================

Please don't commit changes with reStructuredText syntax errors that cause PEP

generation to fail, or result in major rendering defects relative to what you

intend.

Browse the "Read the Docs" preview

----------------------------------

For every PR, we automatically create a preview of the rendered PEPs using

`Read 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 for ``docs/readthedocs.org:pep-previews``

3. Click on "Details" to the right

Render PEPs locally

-------------------

See the `build documentation <./docs/build.rst>`__ for full

instructions on how to render PEPs locally.

In summary, run the following in a fresh, activated virtual environment:

.. code-block:: bash

    # Install requirements

    python -m pip install -U -r requirements.txt

    # Build the PEPs

    make html

    # Or, if you don't have 'make':

    python build.py

The output HTML is found under the ``build`` directory.

Check and lint PEPs

-------------------

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 the `Contributing Guide <./CONTRIBUTING.rst>`_ for details.