Python- v3.4 pip documentation

Edit 0 4 …
Generated
 2014-09-23 23:50:41
Python version
 3.4.1 (v3.4.1:c0e311e010fc, May 18 2014, 10:45:13) [MSC v.1600 64 bit (AMD64)]
pip version
 1.5.6

Contents

Pip invocation

pip <command> [options]

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
 DEPRECATED. Zip individual packages.
unzip
 DEPRECATED. Unzip individual packages.
bundle
 DEPRECATED. 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-file, --local-log
???
 Path to a verbose non-appending log, that only logs failures. This log is active by default at %default.
--log
???
 Path to a verbose appending log. This log is inactive by default.
--log-explicit-levels
???
 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.
Usage (from parser):
  • pip install [options]
Usage (from command object):
  • pip install [options] <requirement specifier> ...
  • pip install [options] -r <requirements file> ...
  • pip install [options] [-e] <vcs project url> ...
  • pip install [options] [-e] <local project path> ...
  • pip install [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

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

DEPRECATED. 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 packages as eggs, not 'flat', like pip normally does. This option is not about installing *from* eggs. (WARNING: Because this option overrides pip's normal install logic, requirements files may not behave as expected.)
--root
<dir>
 Install everything relative to this alternate root directory.
--compile

Compile py files to pyc
--no-compile

Do not compile py files to pyc
--use-wheel

SUPPRESSHELP
--no-use-wheel

Do not Find and prefer wheel archives when searching indexes and find-links locations.
--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 uninstall [options]
Usage (from command object):
  • pip uninstall [options] <package> ...
  • pip uninstall [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

Output installed packages in requirements format.
Usage (from parser):
  • pip freeze [options]
Usage (from command object):
  • pip freeze [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

List installed packages, including editables.
Usage (from parser):
  • pip list [options]
Usage (from command object):
  • pip list [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

Show information about one or more installed packages.
Usage (from parser):
  • pip show [options]
Usage (from command object):
  • pip show [options] <package> ...

Options for show

Long
 Short
 Args
 Description
--files
 -f
Show the full list of installed files for each package.

Command: search

Search for PyPI packages whose name or summary contains <query>.
Usage (from parser):
  • pip search [options]
Usage (from command object):
  • pip search [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 wheel [options]
Usage (from command object):
  • pip wheel [options] <requirement specifier> ...
  • pip wheel [options] -r <requirements file> ...
  • pip wheel [options] <vcs project url> ...
  • pip wheel [options] <local project path> ...
  • pip wheel [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

SUPPRESSHELP
--no-use-wheel

Do not Find and prefer wheel archives when searching indexes and find-links locations.
--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

Zip individual packages.
Usage (from parser):
  • pip zip [options]
Usage (from command object):
  • pip zip [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

Unzip individual packages.
Usage (from parser):
  • pip unzip [options]
Usage (from command object):
  • pip unzip [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

Create pybundles (archives containing multiple packages).
Usage (from parser):
  • pip bundle [options]
Usage (from command object):
  • pip bundle [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

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

DEPRECATED. 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 packages as eggs, not 'flat', like pip normally does. This option is not about installing *from* eggs. (WARNING: Because this option overrides pip's normal install logic, requirements files may not behave as expected.)
--root
<dir>
 Install everything relative to this alternate root directory.
--compile

Compile py files to pyc
--no-compile

Do not compile py files to pyc
--use-wheel

SUPPRESSHELP
--no-use-wheel

Do not Find and prefer wheel archives when searching indexes and find-links locations.
--pre

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

Don't clean up build directories.

Command: help

Show help for commands
Usage (from parser):
  • pip help [options]
Usage (from command object):
  • pip help

Options for help

Long
 Short
 Args
 Description

Method used to analyze pip

  • My program: F:\Proj_Test\Python\pip_doc_34\pip_doc_34.py
  • Python version: 3.4.1 (v3.4.1:c0e311e010fc, May 18 2014, 10:45:13) [MSC v.1600 64 bit (AMD64)]