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> ...
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> ...
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/
Requirements: setuptools>=0.8, and wheel.
’pip wheel’ uses the bdist_wheel setuptools extension from the wheel package to build individual wheels.
Build System Interface¶
In order for pip to build a wheel,
setup.py must implement the
bdist_wheel command with the following syntax:
python setup.py bdist_wheel -d TARGET
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
python -m pip wheel --global-option bdist_ext --global-option -DFOO wheel
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.
Build wheels into <dir>, where the default is the current working directory.
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.
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 older binary packages over newer source packages.
Extra arguments to be supplied to ‘setup.py bdist_wheel’.
Disable isolation when building a modern source distribution. Build dependencies specified by PEP 518 must be already installed if this option is used.
Use PEP 517 for building source distributions (use --no-use-pep517 to force legacy behaviour).
Constrain versions using the given constraints file. This option can be used multiple times.
Install a project in editable mode (i.e. setuptools “develop mode”) from a local project path or a VCS url.
Install from the given requirements file. This option can be used multiple times.
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 the Requires-Python information.
Don’t install package dependencies.
Specify type of progress to be displayed [off|on|ascii|pretty|emoji] (default: on)
Don’t verify if built wheel is valid.
Extra global options to be supplied to the setup.py call before the ‘bdist_wheel’ command.
Include pre-release and development versions. By default, pip only finds stable versions.
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.
Don’t clean up build directories.
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 URLs of package indexes to use in addition to --index-url. Should follow the same rules as --index-url.
Ignore package index (only looking at --find-links URLs instead).
Build wheels for a requirement (and all its dependencies), and then install
python -m pip wheel --wheel-dir=/tmp/wheelhouse SomePackage python -m pip install --no-index --find-links=/tmp/wheelhouse SomePackage
py -m pip wheel --wheel-dir=/tmp/wheelhouse SomePackage py -m pip install --no-index --find-links=/tmp/wheelhouse SomePackage
Build a wheel for a package from source
python -m pip wheel --no-binary SomePackage SomePackage
py -m pip wheel --no-binary SomePackage SomePackage
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:
What problem were you trying to solve when you came to this page?
What content was useful?
What content was not useful?