Created by: gwideman, Nov 7, 2013 3:10 am
Revised by: gwideman, Nov 14, 2013 7:14 pm (11 revisions)

Pip

  • Pip version: 1.4.1
Pip invocation:
????

Pip Commands Summary

Command
Description
install
Install packages.
uninstall
Uninstall packages.
freeze
Output installed packages in requirements format.
list
List installed packages.
show
Show information about installed packages.
search
Search PyPI for packages.
wheel
Build wheels from your requirements.
zip
Zip individual packages.
unzip
Unzip individual packages.
bundle
Create pybundles.
help
Show help for commands.

General options

Long
Short
Args
Description
--help
-h
???
Show help.
--require-virtualenv, --require-venv

???
SUPPRESSHELP
--verbose
-v
???
Give more output. Option is additive, and can be used up to 3 times.
--version
-V
???
Show version and exit.
--quiet
-q
???
Give less output.
--log

???
Log file where a complete (maximum verbosity) record will be kept.
--log-explicit-levels

???
SUPPRESSHELP
--local-log, --log-file

???
SUPPRESSHELP
--no-input

???
SUPPRESSHELP
--proxy

???
Specify a proxy in the form [user:passwd@]proxy.server:port.
--timeout, --default-timeout

???
Set the socket timeout (default %default seconds).
--default-vcs

???
SUPPRESSHELP
--skip-requirements-regex

???
SUPPRESSHELP
--exists-action

???
Default action when a path already exists: (s)witch, (i)gnore, (w)ipe, (b)ackup.
--cert

???
Path to alternate CA bundle.

Pip Command Details

Command: install

Install packages from:
  • PyPI (and other indexes) using requirement specifiers.
  • VCS project urls.
  • Local project directories.
  • Local or remote source archives.
pip also supports installing from "requirements files", which provide an easy way to specify a whole environment to be installed.
See http://www.pip-installer.org for details on VCS url formats and requirements files.
Usage (from parser):
  • pip <command> [options]
Usage (from command object):
  • pip [options] <requirement specifier> ...
  • pip [options] -r <requirements file> ...
  • pip [options] [-e] <vcs project url> ...
  • pip [options] [-e] <local project path> ...
  • pip [options] <archive url/path> ...

Options for install

Long
Short
Args
Description
--editable
-e
<path/url>
Install a project in editable mode (i.e. setuptools "develop mode") from a local project path or a VCS url.
--requirement
-r
<file>
Install from the given requirements file. This option can be used multiple times.
--build, --build-dir, --build-directory
-b
<dir>
Directory to unpack packages into and build in. The default in a virtualenv is "<venv path>/build". The default for global installs is "<OS temp dir>/pip_build_<username>".
--target
-t
<dir>
Install packages into <dir>.
--download, --download-dir, --download-directory
-d
<dir>
Download packages into <dir> instead of installing them, regardless of what's already installed.
--download-cache

<dir>
Cache downloaded packages in <dir>.
--src, --source, --source-dir, --source-directory

<dir>
Directory to check out editable projects into. The default in a virtualenv is "<venv path>/src". The default for global installs is "<current dir>/src".
--upgrade
-U

Upgrade all packages to the newest available version. This process is recursive regardless of whether a dependency is already satisfied.
--force-reinstall


When upgrading, reinstall all packages even if they are already up-to-date.
--ignore-installed
-I

Ignore the installed packages (reinstalling instead).
--no-deps, --no-dependencies


Don't install package dependencies.
--no-install


Download and unpack all packages, but don't actually install them.
--no-download


Don't download any packages, just install the ones already downloaded (completes an install run with --no-install).
--install-option

<options>
Extra arguments to be supplied to the setup.py install command (use like --install-option="--install-scripts=/usr/local/bin"). Use multiple --install-option options to pass multiple options to setup.py install. If you are using an option with a directory path, be sure to use absolute path.
--global-option

<options>
Extra global options to be supplied to the setup.py call before the install command.
--user


Install using the user scheme.
--egg


Install as self contained egg file, like easy_install does.
--root

<dir>
Install everything relative to this alternate root directory.
--use-wheel


Find and prefer wheel archives when searching indexes and find-links locations. Default to accepting source archives.
--pre


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


Don't clean up build directories.

Command: uninstall

Uninstall packages.
pip is able to uninstall most installed packages. Known exceptions are:
  • Pure distutils packages installed with python setup.py install, which leave behind no metadata to determine what files were installed.
  • Script wrappers installed by python setup.py develop.
Usage (from parser):
  • pip <command> [options]
Usage (from command object):
  • pip [options] <package> ...
  • pip [options] -r <requirements file> ...

Options for uninstall

Long
Short
Args
Description
--requirement
-r
<file>
Uninstall all the packages listed in the given requirements file. This option can be used multiple times.
--yes
-y

Don't ask for confirmation of uninstall deletions.

Command: freeze

Usage (from parser):
  • pip <command> [options]
Usage (from command object):
  • pip [options]

Options for freeze

Long
Short
Args
Description
--requirement
-r
<file>
Use the order in the given requirements file and it's comments when generating output.
--find-links
-f
<URL>
URL for finding packages, which will be added to the output.
--local
-l

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

Command: list

Usage (from parser):
  • pip <command> [options]
Usage (from command object):
  • pip [options]

Options for list

Long
Short
Args
Description
--outdated
-o

List outdated packages (excluding editables)
--uptodate
-u

List uptodate packages (excluding editables)
--editable
-e

List editable projects.
--local
-l

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


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

Command: show

Usage (from parser):
  • pip <command> [options]
Usage (from command object):
  • pip [options] <package> ...

Options for show

Long
Short
Args
Description
--files
-f

Show the full list of installed files for each package.

Command: search

Usage (from parser):
  • pip <command> [options]
Usage (from command object):
  • pip [options] <query>

Options for search

Long
Short
Args
Description
--index

<URL>
Base URL of Python Package Index (default %default)

Command: wheel

Build Wheel archives for your requirements and dependencies.
Wheel is a built-package format, and offers the advantage of not recompiling your software during every install. For more details, see the wheel docs: http://wheel.readthedocs.org/en/latest.
Requirements: setuptools>=0.8, and wheel.
'pip wheel' uses the bdist_wheel setuptools extension from the wheel package to build individual wheels.
Usage (from parser):
  • pip <command> [options]
Usage (from command object):
  • pip [options] <requirement specifier> ...
  • pip [options] -r <requirements file> ...
  • pip [options] <vcs project url> ...
  • pip [options] <local project path> ...
  • pip [options] <archive url/path> ...

Options for wheel

Long
Short
Args
Description
--wheel-dir
-w
<dir>
Build wheels into <dir>, where the default is '<cwd>/wheelhouse'.
--use-wheel


Find and prefer wheel archives when searching indexes and find-links locations. Default to accepting source archives.
--build-option

<options>
Extra arguments to be supplied to 'setup.py bdist_wheel'.
--requirement
-r
<file>
Install from the given requirements file. This option can be used multiple times.
--download-cache

<dir>
Cache downloaded packages in <dir>.
--no-deps, --no-dependencies


Don't install package dependencies.
--build, --build-dir, --build-directory
-b
<dir>
Directory to unpack packages into and build in. The default in a virtualenv is "<venv path>/build". The default for global installs is "<OS temp dir>/pip_build_<username>".
--global-option

<options>
Extra global options to be supplied to the setup.py call before the 'bdist_wheel' command.
--pre


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


Don't clean up build directories.

Command: zip

Usage (from parser):
  • pip <command> [options]
Usage (from command object):
  • pip [options] <package> ...

Options for zip

Long
Short
Args
Description
--unzip


Unzip (rather than zip) a package.
--no-pyc


Do not include .pyc files in zip files (useful on Google App Engine).
--list
-l

List the packages available, and their zip status.
--sort-files


With --list, sort packages according to how many files they contain.
--path


Restrict operations to the given paths (may include wildcards).
--simulate
-n

Do not actually perform the zip/unzip operation.

Command: unzip

Usage (from parser):
  • pip <command> [options]
Usage (from command object):
  • pip [options] <package> ...

Options for unzip

Long
Short
Args
Description
--zip


Zip (rather than unzip) a package.
--no-pyc


Do not include .pyc files in zip files (useful on Google App Engine).
--list
-l

List the packages available, and their zip status.
--sort-files


With --list, sort packages according to how many files they contain.
--path


Restrict operations to the given paths (may include wildcards).
--simulate
-n

Do not actually perform the zip/unzip operation.

Command: bundle

Usage (from parser):
  • pip <command> [options]
Usage (from command object):
  • pip [options] <bundle name>.pybundle <package>...

Options for bundle

Long
Short
Args
Description
--editable
-e
<path/url>
Install a project in editable mode (i.e. setuptools "develop mode") from a local project path or a VCS url.
--requirement
-r
<file>
Install from the given requirements file. This option can be used multiple times.
--build, --build-dir, --build-directory
-b
<dir>
Directory to unpack packages into and build in. The default in a virtualenv is "<venv path>/build". The default for global installs is "<OS temp dir>/pip_build_<username>".
--target
-t
<dir>
Install packages into <dir>.
--download, --download-dir, --download-directory
-d
<dir>
Download packages into <dir> instead of installing them, regardless of what's already installed.
--download-cache

<dir>
Cache downloaded packages in <dir>.
--src, --source, --source-dir, --source-directory

<dir>
Directory to check out editable projects into. The default in a virtualenv is "<venv path>/src". The default for global installs is "<current dir>/src".
--upgrade
-U

Upgrade all packages to the newest available version. This process is recursive regardless of whether a dependency is already satisfied.
--force-reinstall


When upgrading, reinstall all packages even if they are already up-to-date.
--ignore-installed
-I

Ignore the installed packages (reinstalling instead).
--no-deps, --no-dependencies


Don't install package dependencies.
--no-install


Download and unpack all packages, but don't actually install them.
--no-download


Don't download any packages, just install the ones already downloaded (completes an install run with --no-install).
--install-option

<options>
Extra arguments to be supplied to the setup.py install command (use like --install-option="--install-scripts=/usr/local/bin"). Use multiple --install-option options to pass multiple options to setup.py install. If you are using an option with a directory path, be sure to use absolute path.
--global-option

<options>
Extra global options to be supplied to the setup.py call before the install command.
--user


Install using the user scheme.
--egg


Install as self contained egg file, like easy_install does.
--root

<dir>
Install everything relative to this alternate root directory.
--use-wheel


Find and prefer wheel archives when searching indexes and find-links locations. Default to accepting source archives.
--pre


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


Don't clean up build directories.

Command: help

Usage (from parser):
  • pip <command> [options]
Usage (from command object):
  • pip <command>

Options for help

Long
Short
Args
Description

Data collection

  • My program: f:\Proj_Test\Python\pip_doc\pip_doc.py
  • Python version: 3.3.2 (v3.3.2:d047928ae3f6, May 16 2013, 00:03:43) [MSC v.1600 32 bit (Intel)]