Skip to content

Commit

Permalink
pypi: switch to standard file_name, add links docs
Browse files Browse the repository at this point in the history
- Use the standard `file_name` qualifier, not `filename`.
- Link to the Python Packaging User Guide for filename conventions.

Thanks to @pombredanne for the suggestions.

Signed-off-by: Mark Lodato <[email protected]>
  • Loading branch information
MarkLodato committed Nov 15, 2024
1 parent 017ec5a commit 0f57b4c
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion PURL-TYPES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -519,10 +519,15 @@ pypi
- PyPI treats ``-`` and ``_`` as the same character and is not case sensitive.
Therefore a PyPI package ``name`` must be lowercased and underscore ``_``
replaced with a dash ``-``.
- The ``filename`` qualifier selects a particular distribution file (case-sensitive).
- The ``file_name`` qualifier selects a particular distribution file
(case-sensitive). For naming convention, see the Python Packaging User Guide on
`source distributions <https://packaging.python.org/en/latest/specifications/source-distribution-format/#source-distribution-file-name>`_
`binary distributions <https://packaging.python.org/en/latest/specifications/binary-distribution-format/#file-name-convention>`_,
and `platform compatibility tags <https://packaging.python.org/en/latest/specifications/platform-compatibility-tags/>`_.
- Examples::

pkg:pypi/[email protected]
pkg:pypi/[email protected]?filename=Django-1.11.1.tar.gz
pkg:pypi/[email protected]?filename=Django-1.11.1-py2.py3-none-any.whl
pkg:pypi/[email protected]

Expand Down

0 comments on commit 0f57b4c

Please sign in to comment.