pip wheel

Usage

Unix/macOS

python -m pip wheel [options] <requirement specifier> ...
python -m pip wheel [options] -r <requirements file> ...
python -m pip wheel [options] [-e] <vcs project url> ...
python -m pip wheel [options] [-e] <local project path> ...
python -m pip wheel [options] <archive url/path> ...

Windows

py -m pip wheel [options] <requirement specifier> ...
py -m pip wheel [options] -r <requirements file> ...
py -m pip wheel [options] [-e] <vcs project url> ...
py -m pip wheel [options] [-e] <local project path> ...
py -m 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: https://wheel.readthedocs.io/en/latest/

’pip wheel’ uses the build system interface as described here: https://pip.pypa.io/en/stable/reference/build-system/

Build System Interface

In order for pip to build a wheel, setup.py must implement the bdist_wheel command with the following syntax:

Unix/macOS

python setup.py bdist_wheel -d TARGET

Windows

py setup.py bdist_wheel -d TARGET

This command must create a wheel compatible with the invoking Python interpreter, and save that wheel in the directory TARGET.

No other build system commands are invoked by the pip wheel command.

Customising the build

It is possible using --global-option to include additional build commands with their arguments in the setup.py command. This is currently the only way to influence the building of C extensions from the command line. For example:

Unix/macOS

python -m pip wheel --global-option bdist_ext --global-option -DFOO wheel

Windows

py -m pip wheel --global-option bdist_ext --global-option -DFOO wheel

will result in a build command of

setup.py bdist_ext -DFOO bdist_wheel -d TARGET

which passes a preprocessor symbol to the extension build.

Such usage is considered highly build-system specific and more an accident of the current implementation than a supported interface.

Options

-w, --wheel-dir <dir>

Build wheels into <dir>, where the default is the current working directory.

--no-binary <format_control>

Do not use binary packages. Can be supplied multiple times, and each time adds to the existing value. Accepts either “:all:” to disable all binary packages, “:none:” to empty the set (notice the colons), or one or more package names with commas between them (no colons). Note that some packages are tricky to compile and may fail to install when this option is used on them.

--only-binary <format_control>

Do not use source packages. Can be supplied multiple times, and each time adds to the existing value. Accepts either “:all:” to disable all source packages, “:none:” to empty the set, or one or more package names with commas between them. Packages without binary distributions will fail to install when this option is used on them.

--prefer-binary

Prefer older binary packages over newer source packages.

--no-build-isolation

Disable isolation when building a modern source distribution. Build dependencies specified by PEP 518 must be already installed if this option is used.

--use-pep517

Use PEP 517 for building source distributions (use --no-use-pep517 to force legacy behaviour).

--check-build-dependencies

Check the build dependencies when PEP517 is used.

-c, --constraint <file>

Constrain versions using the given constraints file. This option can be used multiple times.

-e, --editable <path/url>

Install a project in editable mode (i.e. setuptools “develop mode”) from a local project path or a VCS url.

-r, --requirement <file>

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

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

--ignore-requires-python

Ignore the Requires-Python information.

--no-deps

Don’t install package dependencies.

--progress-bar <progress_bar>

Specify whether the progress bar should be used [on, off] (default: on)

--no-verify

Don’t verify if built wheel is valid.

--config-settings <settings>

Configuration settings to be passed to the PEP 517 build backend. Settings take the form KEY=VALUE. Use multiple --config-settings options to pass multiple keys to the backend.

--build-option <options>

Extra arguments to be supplied to ‘setup.py bdist_wheel’.

--global-option <options>

Extra global options to be supplied to the setup.py call before the install or bdist_wheel command.

--pre

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

--require-hashes

Require a hash to check each requirement against, for repeatable installs. This option is implied when any package in a requirements file has a --hash option.

--no-clean

Don’t clean up build directories.

-i, --index-url <url>

Base URL of the Python Package Index (default https://pypi.org/simple). This should point to a repository compliant with PEP 503 (the simple repository API) or a local directory laid out in the same format.

--extra-index-url <url>

Extra URLs of package indexes to use in addition to --index-url. Should follow the same rules as --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 such as sdist (.tar.gz) or wheel (.whl) files. If a local path or file:// URL that’s a directory, then look for archives in the directory listing. Links to VCS project URLs are not supported.

Examples

1. Build wheels for a requirement (and all its dependencies), and then install

   Unix/macOS

   python -m pip wheel --wheel-dir=/tmp/wheelhouse SomePackage
   python -m pip install --no-index --find-links=/tmp/wheelhouse SomePackage
   

   Windows

   py -m pip wheel --wheel-dir=/tmp/wheelhouse SomePackage
   py -m pip install --no-index --find-links=/tmp/wheelhouse SomePackage
   

2. Build a wheel for a package from source

   Unix/macOS

   python -m pip wheel --no-binary SomePackage SomePackage
   

   Windows

   py -m pip wheel --no-binary SomePackage SomePackage
   

Important

Did this article help?

We are currently doing research to improve pip’s documentation and would love your feedback. Please email us and let us know:

1. What problem were you trying to solve when you came to this page?

2. What content was useful?

3. What content was not useful?