pip

What it does

How to write it

pip install [OPTIONS] PACKAGE ... | -r requirements.txt

Main parts

Commands

install PKG / -r FILE

Install packages / from a requirements file.

uninstall PKG

Remove a package.

freeze

Print installed packages with exact versions.

list [--outdated]

List installed (or old) packages.

show PKG

Details: version, location, requires.

download PKG -d DIR

Download packages without installing (offline installs).

check

Check that dependencies fit together.

cache purge

Empty the pip cache.

Most used

Nothing matches this filter.

$ run as a normal user# run as root (or with sudo)

1. 1A virtual environment for a project

   $python3 -m venv .venv
   $source .venv/bin/activate
   $pip install -r requirements.txt

2. 2Install a pinned version

   $pip install 'requests==2.32.3'

3. 3Save the exact versions

   $pip freeze > requirements.txt

4. 4Small Python image

   $cat Dockerfile
   FROM python:3.12-slim
   WORKDIR /app
   COPY requirements.txt .
   RUN pip install --no-cache-dir -r requirements.txt
   COPY . .
   USER 1000
   CMD ["python", "app.py"]

5. 5Install Ansible for one user

   $python3 -m pip install --user ansible-core

6. 6What is out of date?

   $pip list --outdated

7. 7Use a private mirror

   $pip install -i https://nexus.example.com/repository/pypi/simple -r requirements.txt

8. 8Hash-checked install (supply chain)

   $pip install --require-hashes -r requirements.lock

9. 9Download for an offline server, then install there

   $pip download -r requirements.txt -d wheels/
   $pip install --no-index --find-links wheels/ -r requirements.txt

10. 10Where is a package and what does it need?

    $pip show boto3

11. 11Check for broken dependencies

    $pip check

Nothing matches this filter.

Files

requirements.txt

The package list of a project.

pip.conf (~/.config/pip/pip.conf)

Index URL and other settings.

Exit codes