pip list

Usage

python -m pip list [options]

py -m pip list [options]

Description

List installed packages, including editables.

Packages are listed in a case-insensitive sorted order.

Options

-o, --outdated

List outdated packages

(environment variable: PIP_OUTDATED)

-u, --uptodate

List uptodate packages

(environment variable: PIP_UPTODATE)

-e, --editable

List editable projects.

(environment variable: PIP_EDITABLE)

-l, --local

If in a virtualenv that has global access, do not list globally-installed packages.

(environment variable: PIP_LOCAL)

--user

Only output packages installed in user-site.

(environment variable: PIP_USER)

--path <path>

Restrict to the specified installation path for listing packages (can be used multiple times).

(environment variable: PIP_PATH)

--format <list_format>

Select the output format among: columns (default), freeze, or json. The ‘freeze’ format cannot be used with the --outdated option.

(environment variable: PIP_FORMAT)

--not-required

List packages that are not dependencies of installed packages.

(environment variable: PIP_NOT_REQUIRED)

--exclude-editable

Exclude editable package from output.

(environment variable: PIP_EXCLUDE_EDITABLE)

--include-editable

Include editable package in output.

(environment variable: PIP_INCLUDE_EDITABLE)

--exclude <package>

Exclude specified package from the output

(environment variable: PIP_EXCLUDE)

-i, --index-url <url>

Base URL of the Python Package Index (default https://pypi.org/simple). This should point to a repository compliant with PEP 503 (the simple repository API) or a local directory laid out in the same format.

(environment variable: PIP_INDEX_URL, PIP_PYPI_URL)

--extra-index-url <url>

Extra URLs of package indexes to use in addition to --index-url. Should follow the same rules as --index-url.

(environment variable: PIP_EXTRA_INDEX_URL)

--no-index

Ignore package index (only looking at --find-links URLs instead).

(environment variable: PIP_NO_INDEX)

-f, --find-links <url>

If a URL or path to an html file, then parse for links to archives such as sdist (.tar.gz) or wheel (.whl) files. If a local path or file:// URL that’s a directory, then look for archives in the directory listing. Links to VCS project URLs are not supported.

(environment variable: PIP_FIND_LINKS)

--uploaded-prior-to <datetime>

Only consider packages uploaded prior to the given date time. Accepts ISO 8601 strings (e.g., ‘2023-01-01T00:00:00Z’). Uses local timezone if none specified. Only effective when installing from indexes that provide upload-time metadata.

(environment variable: PIP_UPLOADED_PRIOR_TO)

--pre

Include pre-release and development versions. By default, pip only finds stable versions.

(environment variable: PIP_PRE)

--all-releases <release_control>

Allow all release types (including pre-releases) for a package. Can be supplied multiple times, and each time adds to the existing value. Accepts either “:all:” to allow pre-releases for all packages, “:none:” to empty the set (notice the colons), or one or more package names with commas between them (no colons). Cannot be used with --pre.

(environment variable: PIP_ALL_RELEASES)

--only-final <release_control>

Only allow final releases (no pre-releases) for a package. Can be supplied multiple times, and each time adds to the existing value. Accepts either “:all:” to disable pre-releases for all packages, “:none:” to empty the set, or one or more package names with commas between them. Cannot be used with --pre.

(environment variable: PIP_ONLY_FINAL)

--no-binary <format_control>

Do not use binary packages. Can be supplied multiple times, and each time adds to the existing value. Accepts either “:all:” to disable all binary packages, “:none:” to empty the set (notice the colons), or one or more package names with commas between them (no colons). Note that some packages are tricky to compile and may fail to install when this option is used on them.

(environment variable: PIP_NO_BINARY)

--only-binary <format_control>

Do not use source packages. Can be supplied multiple times, and each time adds to the existing value. Accepts either “:all:” to disable all source packages, “:none:” to empty the set, or one or more package names with commas between them. Packages without binary distributions will fail to install when this option is used on them.

(environment variable: PIP_ONLY_BINARY)

--prefer-binary

Prefer binary packages over source packages, even if the source packages are newer.

(environment variable: PIP_PREFER_BINARY)

Examples

  1. List installed packages (with the default column formatting).

    $ python -m pip list
Package Version
------- -------
docopt  0.6.2
idlex   1.13
jedi    0.9.0

    C:\> py -m pip list
Package Version
------- -------
docopt  0.6.2
idlex   1.13
jedi    0.9.0

  2. List outdated packages with column formatting.

    $ python -m pip list --outdated --format columns
Package    Version Latest Type
---------- ------- ------ -----
retry      0.8.1   0.9.1  wheel
setuptools 20.6.7  21.0.0 wheel

    C:\> py -m pip list --outdated --format columns
Package    Version Latest Type
---------- ------- ------ -----
retry      0.8.1   0.9.1  wheel
setuptools 20.6.7  21.0.0 wheel

  3. List packages that are not dependencies of other packages. Can be combined with other options.

    $ python -m pip list --outdated --not-required
Package  Version Latest Type
-------- ------- ------ -----
docutils 0.14    0.17.1 wheel

    C:\> py -m pip list --outdated --not-required
Package  Version Latest Type
-------- ------- ------ -----
docutils 0.14    0.17.1 wheel

  4. Use json formatting

    $ python -m pip list --format=json
[{'name': 'colorama', 'version': '0.3.7'}, {'name': 'docopt', 'version': '0.6.2'}, ...

    C:\> py -m pip list --format=json
[{'name': 'colorama', 'version': '0.3.7'}, {'name': 'docopt', 'version': '0.6.2'}, ...

  5. Use freeze formatting

    $ python -m pip list --format=freeze
colorama==0.3.7
docopt==0.6.2
idlex==1.13
jedi==0.9.0

    C:\> py -m pip list --format=freeze
colorama==0.3.7
docopt==0.6.2
idlex==1.13
jedi==0.9.0

  6. List packages installed in editable mode

    When some packages are installed in editable mode, pip list outputs an additional column that shows the directory where the editable project is located (i.e. the directory that contains the pyproject.toml or setup.py file).

    $ python -m pip list
Package          Version  Editable project location
---------------- -------- -------------------------------------
pip              21.2.4
pip-test-package 0.1.1    /home/you/.venv/src/pip-test-package
setuptools       57.4.0
wheel            0.36.2

    C:\> py -m pip list
Package          Version  Editable project location
---------------- -------- ----------------------------------------
pip              21.2.4
pip-test-package 0.1.1    C:\Users\You\.venv\src\pip-test-package
setuptools       57.4.0
wheel            0.36.2

    The json format outputs an additional editable_project_location field.

    $ python -m pip list --format=json | python -m json.tool
[
  {
    "name": "pip",
    "version": "21.2.4",
  },
  {
    "name": "pip-test-package",
    "version": "0.1.1",
    "editable_project_location": "/home/you/.venv/src/pip-test-package"
  },
  {
    "name": "setuptools",
    "version": "57.4.0"
  },
  {
    "name": "wheel",
    "version": "0.36.2"
  }
]

    C:\> py -m pip list --format=json | py -m json.tool
[
  {
    "name": "pip",
    "version": "21.2.4",
  },
  {
    "name": "pip-test-package",
    "version": "0.1.1",
    "editable_project_location": "C:\Users\You\.venv\src\pip-test-package"
  },
  {
    "name": "setuptools",
    "version": "57.4.0"
  },
  {
    "name": "wheel",
    "version": "0.36.2"
  }
]

Note

Contrary to the freeze command, pip list --format=freeze will not report editable install information, but the version of the package at the time it was installed.