Skip to content

Commit 47648fb

Browse files
committed
Move redistribution to its own section
1 parent 6d09233 commit 47648fb

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

peps/pep-0804.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,8 @@ canonical, or which versioning scheme applies to virtual DepURLs (see Appendix
207207
B). The corresponding answers are not given in this PEP; instead we delegate
208208
that responsibility to the central registry maintainers.
209209

210+
The canonical filename for the central registry document MUST be ``registry.json``.
211+
210212
Schema
211213
^^^^^^
212214

@@ -264,7 +266,7 @@ Each entry in this list is defined as:
264266
- Description
265267
* - ``id`` (required)
266268
- ``string`` matching regex ``^dep:.+$``
267-
- The entry identifier MUST be a valid ``DepURL`` string.
269+
- The entry identifier MUST be a valid DepURL string.
268270
* - ``description``
269271
- ``string``
270272
- Free-form field to add some details about the package. Allows Markdown.
@@ -616,6 +618,17 @@ required. Extra keys MUST NOT be allowed.
616618
had to be bumped to accommodate a change of release schema). In that regard, we do
617619
not encode explicit mapping semantics for epochs or pre-releases.
618620

621+
Redistribution
622+
--------------
623+
624+
The central registry, the known ecosystems list and the mapping documents MAY be
625+
packaged for offline distribution in each platform.
626+
627+
The authors recommend placing them in the standard location for data artifacts in each
628+
operating system; e.g. ``$XDG_DATA_DIRS`` on Linux and others, ``~/Library/Application
629+
Support`` on macOS, and ``%LOCALAPPDATA%`` for Windows. The subdirectory identifier MUST
630+
be ``external-packaging-metadata-mappings``, and SHOULD only contain documents
631+
corresponding to the aforementioned schemas, which MUST use their canonical filenames.
619632

620633
Examples
621634
--------

0 commit comments

Comments
 (0)