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

Merge pull request #11763 from sbidoul/direct-url-hashes-part-2-sbi

Browse source 
Refine direct URL spec links in install report and inspect docs
This commit is contained in:
Stéphane Bidoul 2023-03-22 10:14:41 +01:00 committed by GitHub
parent 711b5ac6fd 88b1ce5eec
commit 8271fdb349
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/html/reference/inspect-report.md
View file

@ -23,7 +23,7 @@ The report is a JSON object with the following properties:
- `pip_version`: a string with the version of pip used to produce the report.
- `installed`: an array of [InspectReportItem](InspectReportItem) representing the
- `installed`: an array of [`InspectReportItem`](InspectReportItem) representing the
distribution packages that are installed.
- `environment`: an object describing the environment where the installation report was
@ -50,10 +50,11 @@ the following properties:
```
- `direct_url`: Information about the direct URL that was used for installation, if any,
using the [direct
URL](https://packaging.python.org/en/latest/specifications/direct-url/) data
structure. In most case, this field corresponds to the `direct_url.json` metadata,
except for legacy editable installs, where it is emulated.
using the [direct URL data
structure](https://packaging.python.org/en/latest/specifications/direct-url-data-structure/).
In most case, this field corresponds to the
[`direct_url.json`](https://packaging.python.org/en/latest/specifications/direct-url)
metadata, except for legacy editable installs, where it is emulated.
- `requested`: `true` if the `REQUESTED` metadata is present, `false` otherwise. This
field is only present for modern `.dist-info` installations.

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

@ -36,7 +36,7 @@ The report is a JSON object with the following properties:
- `pip_version`: a string with the version of pip used to produce the report.
- `install`: an array of [InstallationReportItem](InstallationReportItem) representing
- `install`: an array of [`InstallationReportItem`](InstallationReportItem) representing
the distribution packages (to be) installed.
- `environment`: an object describing the environment where the installation report was
@ -58,9 +58,10 @@ package with the following properties:
specifier.
- `download_info`: Information about the artifact (to be) downloaded for installation,
using the [direct
URL](https://packaging.python.org/en/latest/specifications/direct-url/) data
structure. When `is_direct` is `true`, this field is the same as the `direct_url.json`
using the [direct URL data
structure](https://packaging.python.org/en/latest/specifications/direct-url-data-structure/).
When `is_direct` is `true`, this field is the same as the
[`direct_url.json`](https://packaging.python.org/en/latest/specifications/direct-url)
metadata, otherwise it represents the URL of the artifact obtained from the index or
`--find-links`.