PEP 752: Add more examples (#3912)

This commit is contained in:
Ofek Lev 2024-08-19 20:58:32 -04:00 committed by GitHub
parent 1f6cac14e0
commit 99e9a5f4b2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 28 additions and 6 deletions

View File

@ -403,23 +403,45 @@ Footnotes
.. [2] Some examples of projects that have many packages with a common prefix: .. [2] Some examples of projects that have many packages with a common prefix:
- `MkDocs <https://github.com/mkdocs/mkdocs>`__ is a documentation framework - `Django <https://www.djangoproject.com>`__ is one of the most widely used
based on Markdown files. They have the concept of frameworks in existence. They have the concept of `middleware`__ which
`plugins <https://www.mkdocs.org/dev-guide/plugins/>`__ which may be allows for third-party packages to modify the request/response cycle.
developed by anyone and by convention are prefixed by ``mkdocs-``. These packages are by convention prefixed by ``django-``.
- `Project Jupyter <https://jupyter.org>`__ is devoted to the development of - `Project Jupyter <https://jupyter.org>`__ is devoted to the development of
tooling for sharing interactive documents. They support `extensions`__ tooling for sharing interactive documents. They support `extensions`__
which in most cases (and in all cases for officially maintained extensions) which in most cases (and in all cases for officially maintained
are prefixed by ``jupyter-``. extensions) are prefixed by ``jupyter-``.
- `pytest <https://docs.pytest.org>`__ is Python's most popular testing
framework. They have the concept of `plugins`__ which may be developed by
anyone and by convention are prefixed by ``pytest-``.
- `MkDocs <https://www.mkdocs.org>`__ is a documentation framework based on
Markdown files. They also have the concept of
`plugins <https://www.mkdocs.org/dev-guide/plugins/>`__ which may be
developed by anyone and are usually prefixed by ``mkdocs-``.
- `Sphinx <https://www.sphinx-doc.org>`__ is a documentation framework
popular for large technical projects such as
`Swift <https://www.swift.org>`__ and Python itself. They have
the concept of `extensions`__ which are prefixed by ``sphinxcontrib-``,
many of which are maintained within a
`dedicated organization <https://github.com/sphinx-contrib>`__.
- `OpenTelemetry <https://opentelemetry.io>`__ is an open standard for - `OpenTelemetry <https://opentelemetry.io>`__ is an open standard for
observability with `official packages`__ for the core APIs and SDK with observability with `official packages`__ for the core APIs and SDK with
`third-party packages`__ to collect data from various sources. All `third-party packages`__ to collect data from various sources. All
packages are prefixed by ``opentelemetry-`` with child prefixes in the packages are prefixed by ``opentelemetry-`` with child prefixes in the
form ``opentelemetry-<component>-<name>-``. form ``opentelemetry-<component>-<name>-``.
- `Apache Airflow <https://airflow.apache.org>`__ is a platform to
programmatically orchestrate tasks as directed acyclic graphs (DAGs).
They have the concept of `plugins`__, and also `providers`__ which are
prefixed by ``apache-airflow-providers-``.
__ https://docs.djangoproject.com/en/5.1/topics/http/middleware/
__ https://jupyterlab.readthedocs.io/en/stable/user/extensions.html __ https://jupyterlab.readthedocs.io/en/stable/user/extensions.html
__ https://docs.pytest.org/en/stable/how-to/writing_plugins.html
__ https://www.sphinx-doc.org/en/master/usage/extensions/index.html
__ https://github.com/open-telemetry/opentelemetry-python __ https://github.com/open-telemetry/opentelemetry-python
__ https://github.com/open-telemetry/opentelemetry-python-contrib __ https://github.com/open-telemetry/opentelemetry-python-contrib
__ https://airflow.apache.org/docs/apache-airflow/stable/authoring-and-scheduling/plugins.html
__ https://airflow.apache.org/docs/apache-airflow-providers/index.html
.. _orgs: https://blog.pypi.org/posts/2023-04-23-introducing-pypi-organizations/ .. _orgs: https://blog.pypi.org/posts/2023-04-23-introducing-pypi-organizations/
.. _corp-orgs: https://docs.pypi.org/organization-accounts/pricing-and-payments/#corporate-organizations .. _corp-orgs: https://docs.pypi.org/organization-accounts/pricing-and-payments/#corporate-organizations