| Server IP : 82.208.35.60 / Your IP : 216.73.216.238 Web Server : Apache/2.4.55 (FreeBSD) OpenSSL/1.1.1q-freebsd PHP/7.3.31 System : FreeBSD server7.d2m.cz 12.4-RELEASE-p9 FreeBSD 12.4-RELEASE-p9 GENERIC amd64 User : studiokobylisy_cz ( 1008) PHP Version : 7.3.31 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : /usr/local/share/doc/py36-pip/reference/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>pip wheel — pip 19.1.1 documentation</title>
<link rel="stylesheet" href="../_static/pypa.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '19.1.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/sidebar.js"></script>
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="pip hash" href="pip_hash.html" />
<link rel="prev" title="pip config" href="pip_config.html" />
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
<script type="text/javascript" src="../_static/copybutton.js"></script>
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="pip_hash.html" title="pip hash"
accesskey="N">next</a></li>
<li class="right" >
<a href="pip_config.html" title="pip config"
accesskey="P">previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://pypa.io">PyPA</a> »</li>
<a href="../index.html">pip 19.1.1 documentation</a> »
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Reference Guide</a> »</li>
<li class="right">
<div class="inline-search" style="display: none" role="search">
<form class="inline-search" action="../search.html" method="get">
<input placeholder="Quick search" type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('.inline-search').show(0);</script>
|
</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="pip-wheel">
<span id="id1"></span><h1><a class="toc-backref" href="#id2">pip wheel</a><a class="headerlink" href="#pip-wheel" title="Permalink to this headline">¶</a></h1>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#pip-wheel" id="id2">pip wheel</a><ul>
<li><a class="reference internal" href="#usage" id="id3">Usage</a></li>
<li><a class="reference internal" href="#description" id="id4">Description</a><ul>
<li><a class="reference internal" href="#build-system-interface" id="id5">Build System Interface</a><ul>
<li><a class="reference internal" href="#customising-the-build" id="id6">Customising the build</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#options" id="id7">Options</a></li>
<li><a class="reference internal" href="#examples" id="id8">Examples</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="usage">
<h2><a class="toc-backref" href="#id3">Usage</a><a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">wheel</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="o"><</span><span class="n">requirement</span> <span class="n">specifier</span><span class="o">></span> <span class="o">...</span>
<span class="n">pip</span> <span class="n">wheel</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="o">-</span><span class="n">r</span> <span class="o"><</span><span class="n">requirements</span> <span class="n">file</span><span class="o">></span> <span class="o">...</span>
<span class="n">pip</span> <span class="n">wheel</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">e</span><span class="p">]</span> <span class="o"><</span><span class="n">vcs</span> <span class="n">project</span> <span class="n">url</span><span class="o">></span> <span class="o">...</span>
<span class="n">pip</span> <span class="n">wheel</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">e</span><span class="p">]</span> <span class="o"><</span><span class="n">local</span> <span class="n">project</span> <span class="n">path</span><span class="o">></span> <span class="o">...</span>
<span class="n">pip</span> <span class="n">wheel</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="o"><</span><span class="n">archive</span> <span class="n">url</span><span class="o">/</span><span class="n">path</span><span class="o">></span> <span class="o">...</span>
</pre></div>
</div>
</div>
<div class="section" id="description">
<h2><a class="toc-backref" href="#id4">Description</a><a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p><p>Build Wheel archives for your requirements and dependencies.</p>
<p>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: <a class="reference external" href="https://wheel.readthedocs.io/en/latest/">https://wheel.readthedocs.io/en/latest/</a></p>
<p>Requirements: setuptools>=0.8, and wheel.</p>
<p>’pip wheel’ uses the bdist_wheel setuptools extension from the wheel
package to build individual wheels.</p>
</p>
<div class="section" id="build-system-interface">
<h3><a class="toc-backref" href="#id5">Build System Interface</a><a class="headerlink" href="#build-system-interface" title="Permalink to this headline">¶</a></h3>
<p>In order for pip to build a wheel, <code class="docutils literal"><span class="pre">setup.py</span></code> must implement the
<code class="docutils literal"><span class="pre">bdist_wheel</span></code> command with the following syntax:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">bdist_wheel</span> <span class="o">-</span><span class="n">d</span> <span class="n">TARGET</span>
</pre></div>
</div>
<p>This command must create a wheel compatible with the invoking Python
interpreter, and save that wheel in the directory TARGET.</p>
<p>No other build system commands are invoked by the <code class="docutils literal"><span class="pre">pip</span> <span class="pre">wheel</span></code> command.</p>
<div class="section" id="customising-the-build">
<h4><a class="toc-backref" href="#id6">Customising the build</a><a class="headerlink" href="#customising-the-build" title="Permalink to this headline">¶</a></h4>
<p>It is possible using <code class="docutils literal"><span class="pre">--global-option</span></code> to include additional build commands
with their arguments in the <code class="docutils literal"><span class="pre">setup.py</span></code> command. This is currently the only
way to influence the building of C extensions from the command line. For
example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">wheel</span> <span class="o">--</span><span class="k">global</span><span class="o">-</span><span class="n">option</span> <span class="n">bdist_ext</span> <span class="o">--</span><span class="k">global</span><span class="o">-</span><span class="n">option</span> <span class="o">-</span><span class="n">DFOO</span> <span class="n">wheel</span>
</pre></div>
</div>
<p>will result in a build command of</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">bdist_ext</span> <span class="o">-</span><span class="n">DFOO</span> <span class="n">bdist_wheel</span> <span class="o">-</span><span class="n">d</span> <span class="n">TARGET</span>
</pre></div>
</div>
<p>which passes a preprocessor symbol to the extension build.</p>
<p>Such usage is considered highly build-system specific and more an accident of
the current implementation than a supported interface.</p>
</div>
</div>
</div>
<div class="section" id="options">
<h2><a class="toc-backref" href="#id7">Options</a><a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
<p><span class="target" id="wheel-wheel-dir"></span><dl class="option">
<dt id="cmdoption-w">
<code class="descname">-w</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--wheel-dir</code><code class="descclassname"> <dir></code><a class="headerlink" href="#cmdoption-w" title="Permalink to this definition">¶</a></dt>
<dd><p>Build wheels into <dir>, where the default is the current working directory.</p>
</dd></dl>
<span class="target" id="wheel-no-binary"></span><dl class="option">
<dt id="cmdoption-no-binary">
<code class="descname">--no-binary</code><code class="descclassname"> <format_control></code><a class="headerlink" href="#cmdoption-no-binary" title="Permalink to this definition">¶</a></dt>
<dd><p>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, or one or more package names with commas between them. Note that some packages are tricky to compile and may fail to install when this option is used on them.</p>
</dd></dl>
<span class="target" id="wheel-only-binary"></span><dl class="option">
<dt id="cmdoption-only-binary">
<code class="descname">--only-binary</code><code class="descclassname"> <format_control></code><a class="headerlink" href="#cmdoption-only-binary" title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
</dd></dl>
<span class="target" id="wheel-prefer-binary"></span><dl class="option">
<dt id="cmdoption-prefer-binary">
<code class="descname">--prefer-binary</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-prefer-binary" title="Permalink to this definition">¶</a></dt>
<dd><p>Prefer older binary packages over newer source packages.</p>
</dd></dl>
<span class="target" id="wheel-build-option"></span><dl class="option">
<dt id="cmdoption-build-option">
<code class="descname">--build-option</code><code class="descclassname"> <options></code><a class="headerlink" href="#cmdoption-build-option" title="Permalink to this definition">¶</a></dt>
<dd><p>Extra arguments to be supplied to ‘setup.py bdist_wheel’.</p>
</dd></dl>
<span class="target" id="wheel-no-build-isolation"></span><dl class="option">
<dt id="cmdoption-no-build-isolation">
<code class="descname">--no-build-isolation</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-no-build-isolation" title="Permalink to this definition">¶</a></dt>
<dd><p>Disable isolation when building a modern source distribution. Build dependencies specified by PEP 518 must be already installed if this option is used.</p>
</dd></dl>
<span class="target" id="wheel-use-pep517"></span><dl class="option">
<dt id="cmdoption-use-pep517">
<code class="descname">--use-pep517</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-use-pep517" title="Permalink to this definition">¶</a></dt>
<dd><p>Use PEP 517 for building source distributions (use –no-use-pep517 to force legacy behaviour).</p>
</dd></dl>
<span class="target" id="wheel-constraint"></span><dl class="option">
<dt id="cmdoption-c">
<code class="descname">-c</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--constraint</code><code class="descclassname"> <file></code><a class="headerlink" href="#cmdoption-c" title="Permalink to this definition">¶</a></dt>
<dd><p>Constrain versions using the given constraints file. This option can be used multiple times.</p>
</dd></dl>
<span class="target" id="wheel-editable"></span><dl class="option">
<dt id="cmdoption-e">
<code class="descname">-e</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--editable</code><code class="descclassname"> <path/url></code><a class="headerlink" href="#cmdoption-e" title="Permalink to this definition">¶</a></dt>
<dd><p>Install a project in editable mode (i.e. setuptools “develop mode”) from a local project path or a VCS url.</p>
</dd></dl>
<span class="target" id="wheel-requirement"></span><dl class="option">
<dt id="cmdoption-r">
<code class="descname">-r</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--requirement</code><code class="descclassname"> <file></code><a class="headerlink" href="#cmdoption-r" title="Permalink to this definition">¶</a></dt>
<dd><p>Install from the given requirements file. This option can be used multiple times.</p>
</dd></dl>
<span class="target" id="wheel-src"></span><dl class="option">
<dt id="cmdoption-src">
<code class="descname">--src</code><code class="descclassname"> <dir></code><a class="headerlink" href="#cmdoption-src" title="Permalink to this definition">¶</a></dt>
<dd><p>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”.</p>
</dd></dl>
<span class="target" id="wheel-ignore-requires-python"></span><dl class="option">
<dt id="cmdoption-ignore-requires-python">
<code class="descname">--ignore-requires-python</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-ignore-requires-python" title="Permalink to this definition">¶</a></dt>
<dd><p>Ignore the Requires-Python information.</p>
</dd></dl>
<span class="target" id="wheel-no-deps"></span><dl class="option">
<dt id="cmdoption-no-deps">
<code class="descname">--no-deps</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-no-deps" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t install package dependencies.</p>
</dd></dl>
<span class="target" id="wheel-build"></span><dl class="option">
<dt id="cmdoption-b">
<code class="descname">-b</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--build</code><code class="descclassname"> <dir></code><a class="headerlink" href="#cmdoption-b" title="Permalink to this definition">¶</a></dt>
<dd><p>Directory to unpack packages into and build in. Note that an initial build still takes place in a temporary directory. The location of temporary directories can be controlled by setting the TMPDIR environment variable (TEMP on Windows) appropriately. When passed, build directories are not cleaned in case of failures.</p>
</dd></dl>
<span class="target" id="wheel-progress-bar"></span><dl class="option">
<dt id="cmdoption-progress-bar">
<code class="descname">--progress-bar</code><code class="descclassname"> <progress_bar></code><a class="headerlink" href="#cmdoption-progress-bar" title="Permalink to this definition">¶</a></dt>
<dd><p>Specify type of progress to be displayed [off|on|ascii|pretty|emoji] (default: on)</p>
</dd></dl>
<span class="target" id="wheel-global-option"></span><dl class="option">
<dt id="cmdoption-global-option">
<code class="descname">--global-option</code><code class="descclassname"> <options></code><a class="headerlink" href="#cmdoption-global-option" title="Permalink to this definition">¶</a></dt>
<dd><p>Extra global options to be supplied to the setup.py call before the ‘bdist_wheel’ command.</p>
</dd></dl>
<span class="target" id="wheel-pre"></span><dl class="option">
<dt id="cmdoption-pre">
<code class="descname">--pre</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-pre" title="Permalink to this definition">¶</a></dt>
<dd><p>Include pre-release and development versions. By default, pip only finds stable versions.</p>
</dd></dl>
<span class="target" id="wheel-no-clean"></span><dl class="option">
<dt id="cmdoption-no-clean">
<code class="descname">--no-clean</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-no-clean" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t clean up build directories.</p>
</dd></dl>
<span class="target" id="wheel-require-hashes"></span><dl class="option">
<dt id="cmdoption-require-hashes">
<code class="descname">--require-hashes</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-require-hashes" title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
</dd></dl>
</p>
<p><span class="target" id="index-url"></span><dl class="option">
<dt id="cmdoption-i">
<code class="descname">-i</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--index-url</code><code class="descclassname"> <url></code><a class="headerlink" href="#cmdoption-i" title="Permalink to this definition">¶</a></dt>
<dd><p>Base URL of Python Package Index (default <a class="reference external" href="https://pypi.org/simple">https://pypi.org/simple</a>). This should point to a repository compliant with PEP 503 (the simple repository API) or a local directory laid out in the same format.</p>
</dd></dl>
<span class="target" id="extra-index-url"></span><dl class="option">
<dt id="cmdoption-extra-index-url">
<code class="descname">--extra-index-url</code><code class="descclassname"> <url></code><a class="headerlink" href="#cmdoption-extra-index-url" title="Permalink to this definition">¶</a></dt>
<dd><p>Extra URLs of package indexes to use in addition to –index-url. Should follow the same rules as –index-url.</p>
</dd></dl>
<span class="target" id="no-index"></span><dl class="option">
<dt id="cmdoption-no-index">
<code class="descname">--no-index</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-no-index" title="Permalink to this definition">¶</a></dt>
<dd><p>Ignore package index (only looking at –find-links URLs instead).</p>
</dd></dl>
<span class="target" id="find-links"></span><dl class="option">
<dt id="cmdoption-f">
<code class="descname">-f</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--find-links</code><code class="descclassname"> <url></code><a class="headerlink" href="#cmdoption-f" title="Permalink to this definition">¶</a></dt>
<dd><p>If a url or path to an html file, then parse for links to archives. If a local path or <a class="reference external" href="file://">file://</a> url that’s a directory, then look for archives in the directory listing.</p>
</dd></dl>
</p>
</div>
<div class="section" id="examples">
<h2><a class="toc-backref" href="#id8">Examples</a><a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<ol class="arabic">
<li><p class="first">Build wheels for a requirement (and all its dependencies), and then install</p>
<blockquote>
<div><div class="highlight-default"><div class="highlight"><pre><span></span>$ pip wheel --wheel-dir=/tmp/wheelhouse SomePackage
$ pip install --no-index --find-links=/tmp/wheelhouse SomePackage
</pre></div>
</div>
</div></blockquote>
</li>
</ol>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installing.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user_guide.html">User Guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Reference Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="pip.html">pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_install.html">pip install</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_download.html">pip download</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_uninstall.html">pip uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_freeze.html">pip freeze</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_list.html">pip list</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_show.html">pip show</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_search.html">pip search</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_check.html">pip check</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip_config.html">pip config</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">pip wheel</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#usage">Usage</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="#options">Options</a></li>
<li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="pip_hash.html">pip hash</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="../news.html">Release Notes</a></li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="pip_config.html"
title="previous chapter">pip config</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="pip_hash.html"
title="next chapter">pip hash</a></p>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="pip_hash.html" title="pip hash"
>next</a></li>
<li class="right" >
<a href="pip_config.html" title="pip config"
>previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="https://pypa.io">PyPA</a> »</li>
<a href="../index.html">pip 19.1.1 documentation</a> »
<li class="nav-item nav-item-1"><a href="index.html" >Reference Guide</a> »</li>
<li class="right">
<div class="inline-search" style="display: none" role="search">
<form class="inline-search" action="../search.html" method="get">
<input placeholder="Quick search" type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('.inline-search').show(0);</script>
|
</li>
</ul>
</div>
<div class="footer">
© <a href="../copyright.html">Copyright</a> 2008-2017, PyPA.
<br />
The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
<br />
<br />
Last updated on Nov 14, 2019.
<a href="https://github.com/pypa/pip/issues">Found a bug</a>?
<br />
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.6.5.
</div>
</body>
</html>