Skip to content

Commit 7439ae8

Browse files
SadeeedManagordmmqz
authored
pip-check, pip-config, pip-debug, pip-download: add page (#18374)
Co-authored-by: Managor <[email protected]> Co-authored-by: Dylan <[email protected]>
1 parent 9983c2a commit 7439ae8

File tree

4 files changed

+93
-0
lines changed

4 files changed

+93
-0
lines changed

pages/common/pip-check.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# pip check
2+
3+
> Check installed packages for broken or incompatible dependencies.
4+
> More information: <https://pip.pypa.io/en/stable/cli/pip_check/>.
5+
6+
- Check for broken or missing requirements:
7+
8+
`pip check`
9+
10+
- Check and log output to a file:
11+
12+
`pip check --log {{path/to/file}}`

pages/common/pip-config.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# pip config
2+
3+
> Manage local and global configuration for pip.
4+
> More information: <https://pip.pypa.io/en/stable/cli/pip_config/>.
5+
6+
- List all configuration values:
7+
8+
`pip config list`
9+
10+
- Show configuration files and their values:
11+
12+
`pip config debug`
13+
14+
- Set the value for a command option:
15+
16+
`pip config set {{command.option}} {{value}} {{--global|--user|--site}}`
17+
18+
- Get the value for a command option:
19+
20+
`pip config get {{command.option}} {{--global|--user|--site}}`
21+
22+
- Unset the value for a command option:
23+
24+
`pip config unset {{command.option}} {{--global|--user|--site}}`
25+
26+
- Edit the configuration file with the default editor:
27+
28+
`pip config edit {{--global|--user|--site}}`
29+
30+
- Edit the configuration file with a specific editor:
31+
32+
`pip config edit {{--global|--user|--site}} --editor {{path/to/editor/binary}}`

pages/common/pip-debug.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# pip debug
2+
3+
> Display debug information about the current pip environment and configuration.
4+
> Intended for debugging; options and output may change without notice.
5+
> More information: <https://pip.pypa.io/en/stable/cli/pip_debug/>.
6+
7+
- Show general debug information:
8+
9+
`pip debug`
10+
11+
- Show debug information for a specific platform:
12+
13+
`pip debug --platform {{platform}}`
14+
15+
- Show debug information for a specific Python version:
16+
17+
`pip debug --python-version {{version}}`
18+
19+
- Show debug information for a specific Python implementation:
20+
21+
`pip debug --implementation {{implementation}}`
22+
23+
- Show debug information for a specific ABI:
24+
25+
`pip debug --abi {{abi}}`

pages/common/pip-download.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# pip download
2+
3+
> Download Python packages without installing them.
4+
> More information: <https://pip.pypa.io/en/stable/cli/pip_download/>.
5+
6+
- Download a package wheel or source archive to the current directory:
7+
8+
`pip download {{package}}`
9+
10+
- Download a specific version of a package:
11+
12+
`pip download {{package}}=={{version}}`
13+
14+
- Download a package and its dependencies to a specific directory:
15+
16+
`pip download {{package}} {{[-d|--dest]}} {{path/to/directory}}`
17+
18+
- Download a package for a specific platform and Python version:
19+
20+
`pip download {{package}} --only-binary :all: --platform {{platform}} --python-version {{version}}`
21+
22+
- Download a package from a specific index URL:
23+
24+
`pip download {{package}} {{[-i|--index-url]}} {{url}}`

0 commit comments

Comments
 (0)