McSinyx/pip
1
1
Fork 0
mirror of https://github.com/pypa/pip synced 2023-12-13 21:30:23 +01:00
Code Issues Releases Activity

Add clarifications to the installation report documentation

Browse source
This commit is contained in:
Stéphane Bidoul 2022-07-19 10:39:11 +02:00
parent b1a01ef762
commit d4b9e187aa
No known key found for this signature in database
GPG key ID: BCAB2555446B5B92
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/html/reference/installation-report.md
View file

@ -6,6 +6,19 @@
The `--report` option of the pip install command produces a detailed JSON report of what
it did install (or what it would have installed, if used with the `--dry-run` option).
```{note}
When considering use cases, please bear in mind that
- while the `--report` option may be used to implement requirement locking tools (among
other use cases), this format is *not* meant to be a lock file format as such;
- there is no plan for pip to accept an installation report as input for the `install`,
`download` or `wheel` commands;
- the `--report` option and this format is intended to become a supported pip feature
(when the format is stabilized to version 1);
- it is however *not* a PyPA interoperability standard and as such its evolution will be
governed by the pip processes and not the PyPA standardization processes.
```
## Specification
The report is a JSON object with the following properties: