Skip to content

PEP 792: additional review feedback #4463

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.

Sign up for GitHub

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

Merged
hugovk merged 3 commits into from
Jun 16, 2025
Merged

PEP 792: additional review feedback #4463

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
41d6b6a
PEP 792: use MUST instead of SHALL
woodruffw Jun 16, 2025
b3b094d
PEP 792: add project status reason
woodruffw Jun 16, 2025
8554b18
PEP 792: don't dangle a sentence
woodruffw Jun 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions peps/pep-0792.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ A project always has exactly one status. If no status is explicitly noted,
then the project is considered to be in the ``active`` state.

Indices **MAY** implement any subset of the status markers specified in this
PEP, as applicable.
PEP, as applicable to their needs.

This PEP does not prescribe *which* principals (i.e. project maintainers,
index administrators, etc.) are allowed to set and unset which statuses.
Expand Down Expand Up @@ -189,10 +189,14 @@ HTML index
The following changes are made to the
:ref:`simple repository API <packaging:simple-repository-api-base>`:

* The per-project index **SHALL** define the ``pypi:repository-version`` as ``1.4``.
* The per-project index **MUST** define the ``pypi:repository-version`` as ``1.4``.
* The per-project index **SHOULD** add an appropriate ``pypi:project-status`` meta tag, with
a ``content`` of the project's status marker. The index **MAY** choose to omit
the ``pypi:project-status`` meta tag if the project is marked as ``active``.
* The per-project index **MAY** include a ``pypi:project-status-reason`` meta tag,
with a ``content`` of free-form text contextualizing the project's status.
The index **MAY** choose to omit the ``pypi:project-status-reason`` meta tag
if the project is marked as ``active`` or if no reason is provided.

For example, the following would be a valid HTML index response for
``sampleproject`` after is has been marked as ``quarantined``:
Expand All @@ -205,6 +209,7 @@ For example, the following would be a valid HTML index response for
<head>
<meta name="pypi:repository-version" content="1.4">
<meta name="pypi:project-status" content="quarantined">
<meta name="pypi:project-status-reason" content="the project is haunted">
Copy link
Contributor

@sethmlarson sethmlarson Jun 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👻

<title>Links for sampleproject</title>
</head>
<body>
Expand All @@ -221,10 +226,14 @@ JSON index
The following changes are made to the
:ref:`JSON simple index <packaging:simple-repository-api-json>`:

* The per-project index **SHALL** define the ``meta.api-version`` as ``1.4``.
* The per-project index **SHOULD** include a ``project-status`` key in the JSON response,
* The per-project index **MUST** define the ``meta.api-version`` as ``1.4``.
* The per-project index **SHOULD** include a ``project-status.state`` key in the JSON response,
with a value of the project's status marker. The index **MAY** choose to omit
the ``project-status`` key if the project is marked as ``active``.
the ``project-status.state`` key if the project is marked as ``active``.
* The per-project index **MAY** include a ``project-status.reason`` key in the JSON response,
with a value of free-form text contextualizing the project's status.
The index **MAY** choose to omit the ``project-status.reason`` key
if the project is marked as ``active`` or if no reason is provided.

For example, the following would be a valid JSON index response for
``sampleproject`` after is has been marked as ``quarantined``:
Expand All @@ -236,7 +245,10 @@ For example, the following would be a valid JSON index response for
"meta": {
"api-version": "1.4"
},
"project-status": "quarantined",
"project-status": {
"status": "quarantined",
"reason": "the project is haunted"
},
"alternate-locations": [],
"files": [],
"name": "sampleproject",
Expand Down