pip-api: Unofficial Importable pip API

0.0.34 · active · verified Thu Apr 09

pip-api is an unofficial Python library providing a programmatic interface to pip's functionality. It allows developers to inspect installed packages, run pip commands, and manage package metadata directly from Python code. The current version is 0.0.34. Due to its nature of wrapping pip's internal APIs, its release cadence is closely tied to pip's updates and internal changes.

Warnings

breaking Support for Python 3.7 was dropped in version 0.0.34. Users on Python 3.7 or older will need to upgrade their Python version or use an older `pip-api` release.
Fix: Upgrade to Python 3.8 or newer, or pin `pip-api<0.0.34`.
gotcha `pip-api` is an *unofficial* API and relies on `pip`'s internal structure, which is not guaranteed to be stable. Updates to `pip` itself can introduce breaking changes for `pip-api` without warning, potentially requiring `pip-api` updates or causing unexpected behavior.
Fix: Monitor `pip-api` releases for compatibility with new `pip` versions and thoroughly test your application after `pip` or `pip-api` upgrades.
gotcha The `pip_api.run()` function directly executes pip commands, which can have side effects such as installing, uninstalling, or upgrading packages in the current environment. This is not a sandboxed operation.
Fix: Exercise caution when using `pip_api.run()` with commands that modify the environment. Consider running in isolated or virtual environments for sensitive operations.
gotcha The `pip_api.installed_packages()` function might incur performance overhead due to parsing package metadata. While `pip-api` aims to be efficient, repeated calls in performance-critical loops might be slow.
Fix: Cache the result of `installed_packages()` if you need to access package information multiple times within a short period or in performance-sensitive sections of your code.

Install

pip install pip-api Install latest version

Imports

installed_packages
```
from pip_api import installed_packages
```
Used to get a dictionary of all installed packages.
run
```
from pip_api import run
```
Used to execute arbitrary pip commands programmatically.

Quickstart

This quickstart demonstrates how to list currently installed packages and how to execute a basic `pip` command using `pip-api`.

from pip_api import installed_packages, run

# List all installed packages
print("Installed Packages:")
for package_name, package_info in installed_packages().items():
    print(f"  {package_info.name}=={package_info.version}")

# Example of running a pip command (e.g., showing details of a package)
# Note: This executes pip directly and can have side effects.
# Use a package that's likely installed, like 'pip' itself.
try:
    # 'run' returns a (stdout, stderr) tuple
    stdout, stderr = run(['show', 'pip'])
    print("\n'pip show pip' output:\n" + stdout.decode('utf-8'))
except Exception as e:
    print(f"Error running pip command: {e}")

view raw JSON →