pip wheel

Usage

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> ...

Description

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.

Options

-w, --wheel-dir <dir>

Build wheels into <dir>, where the default is ‘<cwd>/wheelhouse’.

--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’.

-r, --requirement <file>

Install from the given requirements file. This option can be used multiple times.

--download-cache <dir>

Cache downloaded packages in <dir>.

--no-deps

Don’t install package dependencies.

-b, --build <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.

-i, --index-url <url>

Base URL of Python Package Index (default https://pypi.python.org/simple/).

--extra-index-url <url>

Extra URLs of package indexes to use in addition to –index-url.

--no-index

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

-f, --find-links <url>

If a url or path to an html file, then parse for links to archives. If a local path or file:// url that’s a directory, then look for archives in the directory listing.

--allow-external <package>

Allow the installation of externally hosted files

--allow-all-external

Allow the installation of all externally hosted files

--allow-unverified <package>

Allow the installation of insecure and unverifiable files

Enable the processing of dependency links.

Examples

  1. Build wheels for a requirement (and all its dependencies), and then install
$ pip wheel --wheel-dir=/tmp/wheelhouse SomePackage
$ pip install --no-index --find-links=/tmp/wheelhouse SomePackage