Skip to content

Commit 0f84a36

Browse files
swastim01Managordmmqz
authored
pip-{index, inspect, wheel}: add page (#18387)
Co-authored-by: Managor <[email protected]> Co-authored-by: Dylan <[email protected]>
1 parent 5665561 commit 0f84a36

File tree

3 files changed

+80
-0
lines changed

3 files changed

+80
-0
lines changed

pages/common/pip-index.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# pip index
2+
3+
> Inspect information available from package indexes.
4+
> More information: <https://pip.pypa.io/en/stable/cli/pip_index/>.
5+
6+
- List all available versions of a package:
7+
8+
`pip index versions {{package}}`
9+
10+
- List versions from a specific index:
11+
12+
`pip index versions {{package}} --index-url {{https://test.pypi.org/simple/}}`
13+
14+
- Include pre-release versions:
15+
16+
`pip index versions {{package}} --pre`
17+
18+
- Include an additional index:
19+
20+
`pip index versions {{package}} --extra-index-url {{https://example.com/simple/}}`
21+
22+
- List versions for a specific platform:
23+
24+
`pip index versions {{package}} --platform {{linux_x86_64}}`

pages/common/pip-inspect.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# pip inspect
2+
3+
> Inspect the Python environment and produce a report in JSON format.
4+
> More information: <https://pip.pypa.io/en/stable/cli/pip_inspect/>.
5+
6+
- Inspect the current environment:
7+
8+
`pip inspect`
9+
10+
- Inspect and save output to a file:
11+
12+
`pip inspect > {{environment_report.json}}`
13+
14+
- Inspect only locally installed packages (not global):
15+
16+
`pip inspect --local`
17+
18+
- Inspect only user-installed packages:
19+
20+
`pip inspect --user`
21+
22+
- Inspect packages in a specific path:
23+
24+
`pip inspect --path {{path/to/environment}}`
25+
26+
- Inspect with verbose output (Note: the `-v` flag can be repeated to increase verbosity):
27+
28+
`pip inspect {{[-v|--verbose]}}`

pages/common/pip-wheel.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# pip wheel
2+
3+
> Build wheel archives for packages and dependencies.
4+
> More information: <https://pip.pypa.io/en/stable/cli/pip_wheel/>.
5+
6+
- Build a wheel for a package:
7+
8+
`pip wheel {{package}}`
9+
10+
- Build wheels for packages in requirements file:
11+
12+
`pip wheel {{[-r|--requirement]}} {{path/to/requirements.txt}}`
13+
14+
- Build wheel to a specific directory:
15+
16+
`pip wheel {{package}} {{[-w|--wheel-dir]}} {{path/to/directory}}`
17+
18+
- Build wheel without dependencies:
19+
20+
`pip wheel {{package}} --no-deps`
21+
22+
- Build wheel from local project:
23+
24+
`pip wheel {{path/to/project}}`
25+
26+
- Build wheel from Git repository:
27+
28+
`pip wheel git+{{https://github.com/user/repo.git}}`

0 commit comments

Comments
 (0)