1PIP-WHEEL(1) pip PIP-WHEEL(1)
2
3
4
6 pip-wheel - description of pip wheel command
7
8 IMPORTANT:
9 Did this article help?
10
11 We are currently doing research to improve pip's documentation and
12 would love your feedback. Please email us and let us know why you
13 came to this page and what on it helped you and what did not. (‐
14 Read more about this research)
15
17 Build Wheel archives for your requirements and dependencies.
18
19 Wheel is a built-package format, and offers the advantage of not recom‐
20 piling your software during every install. For more details, see the
21 wheel docs: https://wheel.readthedocs.io/en/latest/
22
23 Requirements: setuptools>=0.8, and wheel.
24
25 'pip wheel' uses the bdist_wheel setuptools extension from the wheel
26 package to build individual wheels.
27
28
30 python -m pip wheel [options] <requirement specifier> ...
31 python -m pip wheel [options] -r <requirements file> ...
32 python -m pip wheel [options] [-e] <vcs project url> ...
33 python -m pip wheel [options] [-e] <local project path> ...
34 python -m pip wheel [options] <archive url/path> ...
35
37 -w, --wheel-dir <dir>
38 Build wheels into <dir>, where the default is the current work‐
39 ing directory.
40
41 --no-binary <format_control>
42 Do not use binary packages. Can be supplied multiple times, and
43 each time adds to the existing value. Accepts either ":all:" to
44 disable all binary packages, ":none:" to empty the set (notice
45 the colons), or one or more package names with commas between
46 them (no colons). Note that some packages are tricky to compile
47 and may fail to install when this option is used on them.
48
49 --only-binary <format_control>
50 Do not use source packages. Can be supplied multiple times, and
51 each time adds to the existing value. Accepts either ":all:" to
52 disable all source packages, ":none:" to empty the set, or one
53 or more package names with commas between them. Packages without
54 binary distributions will fail to install when this option is
55 used on them.
56
57 --prefer-binary
58 Prefer older binary packages over newer source packages.
59
60 --build-option <options>
61 Extra arguments to be supplied to 'setup.py bdist_wheel'.
62
63 --no-build-isolation
64 Disable isolation when building a modern source distribution.
65 Build dependencies specified by PEP 518 must be already in‐
66 stalled if this option is used.
67
68 --use-pep517
69 Use PEP 517 for building source distributions (use
70 --no-use-pep517 to force legacy behaviour).
71
72 -c, --constraint <file>
73 Constrain versions using the given constraints file. This option
74 can be used multiple times.
75
76 -e, --editable <path/url>
77 Install a project in editable mode (i.e. setuptools "develop
78 mode") from a local project path or a VCS url.
79
80 -r, --requirement <file>
81 Install from the given requirements file. This option can be
82 used multiple times.
83
84 --src <dir>
85 Directory to check out editable projects into. The default in a
86 virtualenv is "<venv path>/src". The default for global installs
87 is "<current dir>/src".
88
89 --ignore-requires-python
90 Ignore the Requires-Python information.
91
92 --no-deps
93 Don't install package dependencies.
94
95 --progress-bar <progress_bar>
96 Specify type of progress to be displayed
97 [off|on|ascii|pretty|emoji] (default: on)
98
99 --no-verify
100 Don't verify if built wheel is valid.
101
102 --global-option <options>
103 Extra global options to be supplied to the setup.py call before
104 the 'bdist_wheel' command.
105
106 --pre Include pre-release and development versions. By default, pip
107 only finds stable versions.
108
109 --require-hashes
110 Require a hash to check each requirement against, for repeatable
111 installs. This option is implied when any package in a require‐
112 ments file has a --hash option.
113
114 --no-clean
115 Don't clean up build directories.
116
117
118 IMPORTANT:
119 Did this article help?
120
121 We are currently doing research to improve pip's documentation and
122 would love your feedback. Please email us and let us know:
123
124 1. What problem were you trying to solve when you came to this page?
125
126 2. What content was useful?
127
128 3. What content was not useful?
129
131 pip developers
132
134 2008-2021, PyPA
135
136
137
138
13921.0 May 17, 2021 PIP-WHEEL(1)