Skip to content

Commit

Permalink
PEP 658: Served metadata may be non-static
Browse files Browse the repository at this point in the history
To be clear, the metadata content served should not change (this is
enforced by mandating the served content must match the distribution's
content), but we stop referring the concept as "static" because that
term is also used to identify metadata that may change at build-time,
which means PEP 643 sdist metadata were unnecessarily excluded from
PEP 658.
  • Loading branch information
uranusjr committed May 30, 2021
1 parent 5ba8363 commit 0a4cb49
Showing 1 changed file with 11 additions and 14 deletions.
25 changes: 11 additions & 14 deletions pep-0658.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
PEP: 658
Title: Static Distribution Metadata in the Simple Repository API
Title: Serve Distribution Metadata in the Simple Repository API
Author: Tzu-ping Chung <[email protected]>
Sponsor: Brett Cannon <[email protected]>
PEP-Delegate: Donald Stufft <[email protected]>
Expand Down Expand Up @@ -48,19 +48,16 @@ inspection.
The metadata file defined by the Core Metadata Specification
[core-metadata]_ will be served directly by repositories since it
contains the necessary information for common use cases. The metadata
served must be completely static, i.e. identical to the ``METADATA``
file in the ``.dist-info`` directory [dist-info]_ if the distribution
is installed. The repository can provide this for any distributions,
but it is expected they will only provide them for wheels [wheel]_
at the current time, since an sdist [sdist]_ does not yet have a way
to promise the metadata will stay the same after it is built.

Since not all distributions have static metadata, an HTML attribute
on the distribution file's anchor link is needed to indicate whether a
client is able to choose the separately served metadata file instead.
The attribute is also used to provide the metadata file's hash, so
clients can verify the file after download. If the attribute is
missing from an anchor link, static metadata is not available for the
must only be served for standards-compliant distributions such as
wheels [wheel]_ and sdists [sdist]_, and must be identical to the
distribution's canonical metadata file, such as a wheel's ``METADATA``
file in the ``.dist-info`` directory [dist-info]_.

An HTML attribute on the distribution file's anchor link is needed to
indicate whether a client is able to choose the separately served
metadata file. The attribute is also used to provide the metadata
content's hash for client-side verification. The attribute's absence
indicates that a separate metadata entry is not available for the
distribution, either because of the distribution's content, or lack of
repository support.

Expand Down

0 comments on commit 0a4cb49

Please sign in to comment.