(Search) (../../search/) (Copyright) (../../copyright/) (pip hash) (../pip_hash/) (pip download) (../pip_download/) pip wheel - pip documentation v24.3.dev0 (../../_static/pygments.css?v=a746c00c) (../../_static/styles/furo.css?v=354aac6f) (../../_static/copybutton.css?v=76b2166b) (../../_static/tabs.css?v=4c969af8) (/_/static/css/badge_only.css) (../../_static/styles/furo-extensions.css?v=302659d7) (/_/static/css/readthedocs-doc-embed.css)  Contents    Menu      Expand    Light mode            Dark mode     Auto light/dark, in light mode             Auto light/dark, in dark mode                           Hide navigation sidebar  Hide table of contents sidebar  Skip to content Toggle site navigation sidebar      (../../) pip documentation v24.3.dev0   Toggle Light / Dark / Auto color theme           Toggle table of contents sidebar       (../../) pip documentation v24.3.dev0  (Search) (yes) (default)   (../../getting-started/) Getting Started  (../../installation/) Installation  (../../user_guide/) User Guide  (../../topics/) Topic Guides Toggle navigation of Topic Guides     (../../topics/authentication/) Authentication  (../../topics/caching/) Caching  (../../topics/configuration/) Configuration  (../../topics/dependency-resolution/) Dependency Resolution  (../../topics/more-dependency-resolution/) More on Dependency Resolution  (../../topics/https-certificates/) HTTPS Certificates  (../../topics/local-project-installs/) Local project installs  (../../topics/repeatable-installs/) Repeatable Installs  (../../topics/secure-installs/) Secure installs  (../../topics/vcs-support/) VCS Support  (../../topics/python-option/) Managing a different Python interpreter  (../../topics/workflow/) Pip is not a workflow management tool    (../../reference/) Reference Toggle navigation of Reference     (../../reference/build-system/) Build System Interface Toggle navigation of Build System Interface     (../../reference/build-system/pyproject-toml/) pyproject.toml    (../../reference/build-system/setup-py/) setup.py  (legacy)    (../../reference/requirement-specifiers/) Requirement Specifiers  (../../reference/requirements-file-format/) Requirements File Format  (../../reference/installation-report/) Installation Report  (../../reference/inspect-report/) pip inspect  JSON output specification    (../) Commands Toggle navigation of Commands     (../pip/) pip  (../pip_install/) pip install  (../pip_uninstall/) pip uninstall  (../pip_inspect/) pip inspect  (../pip_list/) pip list  (../pip_show/) pip show  (../pip_freeze/) pip freeze  (../pip_check/) pip check  (../pip_download/) pip download  pip wheel  (../pip_hash/) pip hash  (../pip_search/) pip search  (../pip_cache/) pip cache  (../pip_config/) pip config  (../pip_debug/) pip debug     Project  (../../development/) Development Toggle navigation of Development     (../../development/getting-started/) Getting Started  (../../development/contributing/) Contributing  (../../development/ci/) Continuous Integration  (../../development/issue-triage/) Issue Triage  (../../development/architecture/) Architecture of pip’s internals Toggle navigation of Architecture of pip’s internals     (../../development/architecture/overview/) Broad functionality overview  (../../development/architecture/anatomy/) Repository anatomy & directory structure  (../../development/architecture/configuration-files/) Configuration File Handling  (../../development/architecture/package-finding/) Finding and choosing files (index  and PackageFinder  )  (../../development/architecture/command-line-interface/) Command Line Interface  (../../development/architecture/upgrade-options/) Options that control the installation process    (../../development/release-process/) Release process  (../../development/vendoring-policy/) Vendoring Policy    (../../ux-research-design/) UX Research & Design Toggle navigation of UX Research & Design     (../../ux-research-design/contribute/) How to Contribute  (../../ux-research-design/guidance/) UX Guidance  (../../ux-research-design/research-results/) UX Research Results Toggle navigation of UX Research Results     (../../ux-research-design/research-results/about-our-users/) About pip’s Users  (../../ux-research-design/research-results/mental-models/) How Users Understand pip  (../../ux-research-design/research-results/users-and-security/) How pip users think about security  (../../ux-research-design/research-results/ci-cd/) How pip is used in interactive environments (i.e. CI, CD)  (../../ux-research-design/research-results/personas/) pip Personas  (../../ux-research-design/research-results/prioritizing-features/) Prioritizing pip Features  (../../ux-research-design/research-results/override-conflicting-dependencies/) Providing an override to install packages with conflicting dependencies  (../../ux-research-design/research-results/pip-force-reinstall/) pip --force-reinstall  (../../ux-research-design/research-results/pip-search/) pip search  (../../ux-research-design/research-results/pip-upgrade-conflict/) pip Upgrade Conflict  (../../ux-research-design/research-results/improving-pips-documentation/) Improving pip’s Documentation      (../../news/) Changelog  (https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md) Code of Conduct  (https://github.com/pypa/pip) GitHub       v: latest   v: latest   Versions (https://pip.pypa.io/en/latest/cli/pip_wheel/) latest  (https://pip.pypa.io/en/stable/cli/pip_wheel/) stable   On Read the Docs (//readthedocs.org/projects/pip/) Project Home  (//readthedocs.org/projects/pip/builds/) Builds  (//readthedocs.org/projects/pip/downloads/) Downloads   On GitHub (https://github.com/pypa/pip/blob/main/docs/html/cli/pip_wheel.rst) View  (https://github.com/pypa/pip/edit/main/docs/html/cli/pip_wheel.rst) Edit   Search (Search docs)     Hosted by (https://readthedocs.org) Read the Docs  ·  (https://docs.readthedocs.io/page/privacy-policy.html) Privacy Policy            Back to top  (../../_sources/cli/pip_wheel.rst.txt) (View this page)   View this page   (https://github.com/pypa/pip/edit/main/docs/html/cli/pip_wheel.rst) (Edit this page)   Edit this page   Toggle Light / Dark / Auto color theme           Toggle table of contents sidebar       pip wheel(Link to this heading) ¶  Usage(Link to this heading) ¶  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 > ...  Copy to clipboard         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 > ...  Copy to clipboard           Description(Link to this heading) ¶   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/) 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/) https://pip.pypa.io/en/stable/reference/build-system/   Build System Interface This is now covered in (../../reference/build-system/) Build System Interface  . Differences to build  (Link to this heading) ¶  (https://pypi.org/project/build/) build is a simple tool which can among other things build
wheels for projects using the standard pyproject.toml  -based build interface. It
is comparable to the execution of pip wheel --no-deps .  .
It can also build source distributions which is not possible with pip  . pip wheel  covers the wheel scope of build  but offers many additional features.   Options(Link to this heading) ¶     -w   ,  --wheel-dir  <dir>  (Link to this definition) ¶  Build wheels into <dir>, where the default is the current working directory. (environment variable: PIP_WHEEL_DIR  )    --no-binary  <format_control>  (Link to this definition) ¶  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. (environment variable: PIP_NO_BINARY  )    --only-binary  <format_control>  (Link to this definition) ¶  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. (environment variable: PIP_ONLY_BINARY  )    --prefer-binary   (Link to this definition) ¶  Prefer binary packages over source packages, even if the source packages are newer. (environment variable: PIP_PREFER_BINARY  )    --no-build-isolation   (Link to this definition) ¶  Disable isolation when building a modern source distribution. Build dependencies specified by PEP 518 must be already installed if this option is used. (environment variable: PIP_NO_BUILD_ISOLATION  )    --use-pep517   (Link to this definition) ¶  Use PEP 517 for building source distributions (use --no-use-pep517 to force legacy behaviour). (environment variable: PIP_USE_PEP517  )    --check-build-dependencies   (Link to this definition) ¶  Check the build dependencies when PEP517 is used. (environment variable: PIP_CHECK_BUILD_DEPENDENCIES  )     -c   ,  --constraint  <file>  (Link to this definition) ¶  Constrain versions using the given constraints file. This option can be used multiple times. (environment variable: PIP_CONSTRAINT  )     -e   ,  --editable  <path/url>  (Link to this definition) ¶  Install a project in editable mode (i.e. setuptools “develop mode”) from a local project path or a VCS url. (environment variable: PIP_EDITABLE  )     -r   ,  --requirement  <file>  (Link to this definition) ¶  Install from the given requirements file. This option can be used multiple times. (environment variable: PIP_REQUIREMENT  )    --src  <dir>  (Link to this definition) ¶  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”. (environment variable: PIP_SRC  , PIP_SOURCE  , PIP_SOURCE_DIR  , PIP_SOURCE_DIRECTORY  )    --ignore-requires-python   (Link to this definition) ¶  Ignore the Requires-Python information. (environment variable: PIP_IGNORE_REQUIRES_PYTHON  )    --no-deps   (Link to this definition) ¶  Don’t install package dependencies. (environment variable: PIP_NO_DEPS  , PIP_NO_DEPENDENCIES  )    --progress-bar  <progress_bar>  (Link to this definition) ¶  Specify whether the progress bar should be used [on, off, raw] (default: on) (environment variable: PIP_PROGRESS_BAR  )    --no-verify   (Link to this definition) ¶  Don’t verify if built wheel is valid. (environment variable: PIP_NO_VERIFY  )     -C   ,  --config-settings  <settings>  (Link to this definition) ¶  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. (environment variable: PIP_CONFIG_SETTINGS  )    --build-option  <options>  (Link to this definition) ¶  Extra arguments to be supplied to ‘setup.py bdist_wheel’. (environment variable: PIP_BUILD_OPTION  )    --global-option  <options>  (Link to this definition) ¶  Extra global options to be supplied to the setup.py call before the install or bdist_wheel command. (environment variable: PIP_GLOBAL_OPTION  )    --pre   (Link to this definition) ¶  Include pre-release and development versions. By default, pip only finds stable versions. (environment variable: PIP_PRE  )    --require-hashes   (Link to this definition) ¶  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. (environment variable: PIP_REQUIRE_HASHES  )    --no-clean   (Link to this definition) ¶  Don’t clean up build directories. (environment variable: PIP_NO_CLEAN  )       -i   ,  --index-url  <url>  (Link to this definition) ¶  Base URL of the Python Package Index (default (https://pypi.org/simple) 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. (environment variable: PIP_INDEX_URL  , PIP_PYPI_URL  )    --extra-index-url  <url>  (Link to this definition) ¶  Extra URLs of package indexes to use in addition to --index-url. Should follow the same rules as --index-url. (environment variable: PIP_EXTRA_INDEX_URL  )    --no-index   (Link to this definition) ¶  Ignore package index (only looking at --find-links URLs instead). (environment variable: PIP_NO_INDEX  )     -f   ,  --find-links  <url>  (Link to this definition) ¶  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://) file:// URL that’s a directory, then look for archives in the directory listing. Links to VCS project URLs are not supported. (environment variable: PIP_FIND_LINKS  )     Examples(Link to this heading) ¶  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  Copy to clipboard         Windows  py -m pip wheel --wheel-dir= /tmp/wheelhouse SomePackage
py -m pip install --no-index --find-links= /tmp/wheelhouse SomePackage  Copy to clipboard           Build a wheel for a package from source Unix/macOS  python -m pip wheel --no-binary SomePackage SomePackage  Copy to clipboard         Windows  py -m pip wheel --no-binary SomePackage SomePackage  Copy to clipboard                (../pip_hash/) Next  pip hash     (../pip_download/)   Previous  pip download    (../../copyright/) Copyright © The pip developers  Made with (https://www.sphinx-doc.org/) Sphinx and (https://pradyunsg.me) @pradyunsg 's (https://github.com/pradyunsg/furo) Furo  (https://readthedocs.org/projects/pip)    (https://github.com/pypa/pip)         On this page   pip wheel Usage  Description Differences to build      Options  Examples