Skip to content

Commit

Permalink
Merge pull request #375 from saaketp/PackageMetadata-docs
Browse files Browse the repository at this point in the history
Add note about PackageMetadata protocol and include link to importlib_metadata docs in usage.
  • Loading branch information
jaraco committed Mar 20, 2022
2 parents 28ee235 + 5f375a9 commit 96e533b
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/using.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ By default, package metadata can live on the file system or in zip archives on
anywhere.


.. seealso::

https://importlib-metadata.readthedocs.io/
The documentation for ``importlib_metadata``, which supplies a
backport of ``importlib.metadata``.


Overview
========

Expand Down Expand Up @@ -162,6 +169,13 @@ all the metadata in a JSON-compatible form per PEP 566::
>>> wheel_metadata.json['requires_python']
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'

.. note::

The actual type of the object returned by ``metadata()`` is an
implementation detail and should be accessed only through the interface
described by the
`PackageMetadata protocol <https://importlib-metadata.readthedocs.io/en/latest/api.html#importlib_metadata.PackageMetadata>`.


.. _version:

Expand Down

0 comments on commit 96e533b

Please sign in to comment.