pip

https://pip.pypa.io/en/stable/
Admin
pip is the package installer for Python that enables users to install packages from the Python...
Tokens:270,471
Snippets:2,593
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install multiple packages using a requirements file

Source: https://pip.pypa.io/en/stable/_sources/getting-started.md.txt

Installs all packages listed in a requirements.txt file. The example shows the command and a successful installation message.

```bash
$ pip install -r requirements.txt
[...]
Successfully installed sampleproject
```

--------------------------------

### pip install dependency cycle example on Unix/macOS

Source: https://pip.pypa.io/en/stable/_sources/cli/pip_install.rst.txt

Demonstrates the installation order when there is a dependency cycle, showing that the first encountered member of the cycle is installed last.

```console
$ python -m pip install quux
...
Installing collected packages baz, bar, foo, quux

$ python -m pip install bar
...
Installing collected packages foo, baz, bar
```

--------------------------------

### pip install dependency cycle example on Windows

Source: https://pip.pypa.io/en/stable/_sources/cli/pip_install.rst.txt

Demonstrates the installation order when there is a dependency cycle on Windows, showing that the first encountered member of the cycle is installed last.

```console
C:\> py -m pip install quux
...
Installing collected packages baz, bar, foo, quux

C:\> py -m pip install bar
...
Installing collected packages foo, baz, bar
```

--------------------------------

### Install to user site on Windows when package not installed globally

Source: https://pip.pypa.io/en/stable/_sources/user_guide.rst.txt

Windows example of installing SomePackage into the user site when it is not installed globally. The command succeeds and reports 'Successfully installed SomePackage'.

```console
C:\> py -m pip install --user SomePackage
[...]
Successfully installed SomePackage
```

--------------------------------

### Install a package from GitHub

Source: https://pip.pypa.io/en/stable/_sources/getting-started.md.txt

Installs a package directly from a Git repository using the git+https URL syntax. The example installs from the main branch of the sampleproject repository.

```bash
$ pip install git+https://github.com/pypa/sampleproject.git@main
[...]
Successfully installed sampleproject
```

--------------------------------

### Global options example: --pre, --no-index, --find-links

Source: https://pip.pypa.io/en/stable/_sources/reference/requirements-file-format.md.txt

Example of global pip install options that affect the entire run, specified on individual lines. Shows --pre, --no-index, and two --find-links locations.

```text
--pre
--no-index
--find-links /my/local/archives
--find-links http://some.archives.com/archives
```

--------------------------------

### pip install --all-releases (Windows)

Source: https://pip.pypa.io/en/stable/user_guide

Windows equivalent of the --all-releases example. Use --all-releases to allow pre-releases for specific packages or all packages with :all:.

```bash
py -m pip install --all-releases=DependencyPackage SomePackage
py -m pip install --all-releases=:all: SomePackage
```

--------------------------------

### Install Git repository with pip

Source: https://pip.pypa.io/en/stable/news

Install a Git repository without making it editable. This example installs the pip repository from GitHub using the git+https scheme.

```bash
pip install git+https://github.com/pypa/pip/

```

--------------------------------

### pip install --uploaded-prior-to (Windows)

Source: https://pip.pypa.io/en/stable/user_guide

Windows equivalent of the --uploaded-prior-to example. Use --uploaded-prior-to to filter packages by upload time, accepting ISO 8601 datetime strings or a duration in PnD format.

```bash
py -m pip install --uploaded-prior-to=2025-03-16T00:00:00Z SomePackage
py -m pip install --uploaded-prior-to=P3D SomePackage
```

--------------------------------

### Install pip with get-pip.py

Source: https://pip.pypa.io/en/stable/news

Download and run the get-pip.py installer using the Python interpreter of your choice. May need to be run as root, and distribute must be installed before using the installer.

```bash
$ curl -O https://raw.github.com/pypa/pip/master/contrib/get-pip.py
$ python get-pip.py

```

--------------------------------

### Directory Structure for Multiple Projects

Source: https://pip.pypa.io/en/stable/user_guide

Directory structure example showing two subprojects, each with its own pyproject.toml, used to install groups from multiple projects at once.

```text
+ project/
  + sub1/
    - pyproject.toml
  + sub2/
    - pyproject.toml

```

--------------------------------

### pip install --only-final (Windows)

Source: https://pip.pypa.io/en/stable/user_guide

Windows equivalent of the --only-final example. Use --only-final to explicitly disable pre-releases for specific packages or all packages with :all:.

```bash
py -m pip install --only-final=DependencyPackage SomePackage
py -m pip install --only-final=:all: SomePackage
```

--------------------------------

### Force user install with --ignore-installed

Source: https://pip.pypa.io/en/stable/user_guide

When SomePackage is installed globally and is the latest version, --user install reports 'Requirement already satisfied' and --upgrade reports 'Requirement already up-to-date'. Use --ignore-installed to force the install, which then prints 'Successfully installed SomePackage'.

```bash
$ python -m pip install --user SomePackage
[...]
Requirement already satisfied (use --upgrade to upgrade)
$ python -m pip install --user --upgrade SomePackage
[...]
Requirement already up-to-date: SomePackage
# force the install
$ python -m pip install --user --ignore-installed SomePackage
[...]
Successfully installed SomePackage

```

```batch
C:\> py -m pip install --user SomePackage
[...]
Requirement already satisfied (use --upgrade to upgrade)
C:\> py -m pip install --user --upgrade SomePackage
[...]
Requirement already up-to-date: SomePackage
# force the install
C:\> py -m pip install --user --ignore-installed SomePackage
[...]
Successfully installed SomePackage

```

--------------------------------

### Install from local packages (Unix/macOS)

Source: https://pip.pypa.io/en/stable/user_guide

Installs packages from local only, using --find-links and --no-index to avoid traffic to PyPI on Unix/macOS.

```bash
python -m pip install --no-index --find-links=DIR -r requirements.txt

```

--------------------------------

### Install pip 20.3 and validate environment

Source: https://pip.pypa.io/en/stable/user_guide

Install pip 20.3 to enable the new resolver, then validate the current environment for dependency inconsistencies before testing.

```bash
python -m pip install --upgrade pip
```

```bash
pip check
```

--------------------------------

### Install with custom PYTHONUSERBASE

Source: https://pip.pypa.io/en/stable/user_guide

Sets the PYTHONUSERBASE environment variable to /myappenv (or c:/myappenv on Windows) and installs SomePackage into the user site. Use this to customize the user scheme install location.

```bash
export PYTHONUSERBASE=/myappenv
python -m pip install --user SomePackage

```

```batch
set PYTHONUSERBASE=c:/myappenv
py -m pip install --user SomePackage

```

--------------------------------

### Install from local packages (Windows)

Source: https://pip.pypa.io/en/stable/user_guide

Installs packages from local only, using --find-links and --no-index to avoid traffic to PyPI on Windows.

```powershell
py -m pip install --no-index --find-links=DIR -r requirements.txt

```

--------------------------------

### User install in --system-site-packages virtualenv fails

Source: https://pip.pypa.io/en/stable/user_guide

In a --system-site-packages virtualenv where SomePackage==0.3 is already installed, installing SomePackage==0.4 with --user fails because the user site lacks sys.path precedence. The command prints 'Will not install to the user site because it will lack sys.path precedence'.

```bash
$ python -m pip install --user SomePackage==0.4
Will not install to the user site because it will lack sys.path precedence

```

```batch
C:\> py -m pip install --user SomePackage==0.4
Will not install to the user site because it will lack sys.path precedence

```

--------------------------------

### Install with --refresh-package (Windows)

Source: https://pip.pypa.io/en/stable/user_guide

Use on Windows to install a package while refreshing its metadata immediately, bypassing cached package index information.

```bash
py -m pip install --refresh-package=requests requests

```

--------------------------------

### User install with --upgrade when global package is outdated

Source: https://pip.pypa.io/en/stable/user_guide

When SomePackage is installed globally but not the latest version, a plain --user install reports 'Requirement already satisfied (use --upgrade to upgrade)'. Adding --upgrade installs the latest version and prints 'Successfully installed SomePackage'.

```bash
$ python -m pip install --user SomePackage
[...]
Requirement already satisfied (use --upgrade to upgrade)
$ python -m pip install --user --upgrade SomePackage
[...]
Successfully installed SomePackage

```

```batch
C:\> py -m pip install --user SomePackage
[...]
Requirement already satisfied (use --upgrade to upgrade)
C:\> py -m pip install --user --upgrade SomePackage
[...]
Successfully installed SomePackage

```

--------------------------------

### Install with --refresh-package (Unix/macOS)

Source: https://pip.pypa.io/en/stable/user_guide

Use on Unix/macOS to install a package while refreshing its metadata immediately, bypassing cached package index information.

```bash
python -m pip install --refresh-package=requests requests

```

--------------------------------

### Build wheels for local installation (Windows)

Source: https://pip.pypa.io/en/stable/user_guide

Builds wheels for requirements that don't come as wheels from PyPI, saving them to the specified directory on Windows. Use this if you've never installed your requirements before and want wheels.

```powershell
py -m pip wheel --wheel-dir DIR -r requirements.txt

```

--------------------------------

### Install Groups from Multiple Projects (Windows)

Source: https://pip.pypa.io/en/stable/user_guide

Windows command to install dependency groups from two different projects simultaneously by specifying explicit paths.

```bash
py -m pip install --group './sub1/pyproject.toml:groupA' --group './sub2/pyproject.toml:groupB'

```
Tokens:
Raw