-
-
Notifications
You must be signed in to change notification settings - Fork 4.8k
pip-check, pip-config, pip-debug, pip-download: add page #18374
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Managor
merged 9 commits into
tldr-pages:main
from
Sadeeed:pip-check-config-debug-download
Oct 7, 2025
Merged
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
5ea7127
pip-check, pip-config: add page
Sadeeed 325ce9e
pip-debug, pip-download: add page
Sadeeed 2f239e2
Update pages/common/pip-config.md
Sadeeed 5c0d86d
pip-download: fix index-url shorthand
Sadeeed 40822d6
pip-download: fix platform and python version example
Sadeeed 4e0fcfb
pip-download: update example
Sadeeed bb37914
pip-config: fix argument order
Sadeeed 7c6fa12
pip-config: update options order
Sadeeed 456b432
pip-download: update options order
Sadeeed File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# pip check | ||
|
||
> Check installed packages for broken or incompatible dependencies. | ||
> More information: <https://pip.pypa.io/en/stable/cli/pip_check/>. | ||
|
||
- Check for broken or missing requirements: | ||
|
||
`pip check` | ||
|
||
- Check and log output to a file: | ||
|
||
`pip check --log {{path/to/file}}` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# pip config | ||
|
||
> Manage local and global configuration for pip. | ||
> More information: <https://pip.pypa.io/en/stable/cli/pip_config/>. | ||
|
||
- List all configuration values: | ||
|
||
`pip config list` | ||
|
||
- Show configuration files and their values: | ||
|
||
`pip config debug` | ||
|
||
- Set the value for a command option: | ||
|
||
`pip {{--global| --user| --site}} config set {{command.option}} {{value}}` | ||
|
||
- Get the value for a command option: | ||
|
||
`pip {{--global| --user| --site}} config get {{command.option}}` | ||
|
||
- Unset the value for a command option: | ||
|
||
`pip {{--global| --user| --site}} config unset {{command.option}}` | ||
|
||
- Edit the configuration file with the default editor: | ||
|
||
`pip {{--global| --user| --site}} config edit` | ||
|
||
- Edit the configuration file with a specific editor: | ||
|
||
`pip {{--global| --user| --site}} --editor {{path/to/editor/binary}} config edit` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# pip debug | ||
|
||
> Display debug information about the current pip environment and configuration. | ||
> Intended for debugging; options and output may change without notice. | ||
> More information: <https://pip.pypa.io/en/stable/cli/pip_debug/>. | ||
|
||
- Show general debug information: | ||
|
||
`pip debug` | ||
|
||
- Show debug information for a specific platform: | ||
|
||
`pip debug --platform {{platform}}` | ||
|
||
- Show debug information for a specific Python version: | ||
|
||
`pip debug --python-version {{version}}` | ||
|
||
- Show debug information for a specific Python implementation: | ||
|
||
`pip debug --implementation {{implementation}}` | ||
|
||
- Show debug information for a specific ABI: | ||
|
||
`pip debug --abi {{abi}}` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# pip download | ||
|
||
> Download Python packages without installing them. | ||
> More information: <https://pip.pypa.io/en/stable/cli/pip_download/>. | ||
|
||
- Download a package wheel or source archive to the current directory: | ||
|
||
`pip download {{package}}` | ||
|
||
- Download a specific version of a package: | ||
|
||
`pip download {{package}}=={{version}}` | ||
|
||
- Download a package and its dependencies to a specific directory: | ||
|
||
`pip download {{[-d|--dest]}} {{path/to/directory}} {{package}}` | ||
|
||
- Download a package for a specific platform and Python version: | ||
|
||
`pip download --platform {{platform}} --python-version {{version}} {{package}}` | ||
Sadeeed marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
- Download a package from a specific index URL: | ||
|
||
`pip download {{[-u|--index-url]}} {{url}} {{package}}` | ||
Sadeeed marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.