Skip to content

Commit

Permalink
Add details on package location and metadata parsing
Browse files Browse the repository at this point in the history
  • Loading branch information
deveshks committed May 21, 2020
1 parent e49a3ad commit 898710e
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/html/reference/pip_show.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ The various fields present in the JSON output and their explanation is as follow

*metadata*
A dictionary with the core metadata fields present in the ``METADATA`` file,
as defined in the `Core metadata specifications`_. The fields are
as defined in the `Core metadata specifications`_. We use the method detailed in
`JSON-compatible Metadata`_ to convert core metadata to json. The fields are
lower cased, with dashes replaced by underscores.

*direct_url*
Expand All @@ -56,9 +57,12 @@ The various fields present in the JSON output and their explanation is as follow
on the queried distribution.

*location*
A string containing the path where the distribution is installed.
A string containing the path where the distribution is installed. For legacy installs,
this is the parent directory of the metadata (.dist-info or .egg-info) directory.
For legacy editable installs, this is the directory where the source is located.

.. _`Core metadata specifications`: https://packaging.python.org/specifications/core-metadata/
.. _`JSON-compatible Metadata`: https://www.python.org/dev/peps/pep-0566/#json-compatible-metadata

Examples
========
Expand Down

0 comments on commit 898710e

Please sign in to comment.