[5a2aca5] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 | ]>
|
---|
| 7 |
|
---|
| 8 | <sect1 id="ch-system-wheel" role="wrap">
|
---|
| 9 | <?dbhtml filename="wheel.html"?>
|
---|
| 10 |
|
---|
| 11 | <sect1info condition="script">
|
---|
| 12 | <productname>wheel</productname>
|
---|
| 13 | <productnumber>&wheel-version;</productnumber>
|
---|
| 14 | <address>&wheel-url;</address>
|
---|
| 15 | </sect1info>
|
---|
| 16 |
|
---|
[4b51d83b] | 17 | <title>Wheel-&wheel-version;</title>
|
---|
[5a2aca5] | 18 |
|
---|
| 19 | <indexterm zone="ch-system-wheel">
|
---|
| 20 | <primary sortas="a-wheel">wheel</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect2 role="package">
|
---|
| 24 | <title/>
|
---|
| 25 |
|
---|
[ee16e55] | 26 | <para>Wheel is a Python library that is the reference
|
---|
[5a2aca5] | 27 | implementation of the Python wheel packaging standard.</para>
|
---|
| 28 |
|
---|
| 29 | <segmentedlist>
|
---|
| 30 | <segtitle>&buildtime;</segtitle>
|
---|
| 31 | <segtitle>&diskspace;</segtitle>
|
---|
| 32 | <seglistitem>
|
---|
| 33 | <seg>&wheel-fin-sbu;</seg>
|
---|
| 34 | <seg>&wheel-fin-du;</seg>
|
---|
| 35 | </seglistitem>
|
---|
| 36 | </segmentedlist>
|
---|
| 37 |
|
---|
| 38 | </sect2>
|
---|
| 39 |
|
---|
| 40 | <sect2 role="installation">
|
---|
| 41 | <title>Installation of Wheel</title>
|
---|
| 42 |
|
---|
[e3187f4] | 43 | <para>Compile wheel with the following command:</para>
|
---|
| 44 |
|
---|
| 45 | <screen><userinput remap="make">PYTHONPATH=src pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>
|
---|
| 46 |
|
---|
[5a2aca5] | 47 | <para>Install wheel with the following command:</para>
|
---|
| 48 |
|
---|
[e3187f4] | 49 | <screen><userinput remap="install">pip3 install --no-index --find-links=dist wheel</userinput></screen>
|
---|
[5a2aca5] | 50 |
|
---|
| 51 | <variablelist>
|
---|
[e3187f4] | 52 | <title>The meaning of the pip3 commands:</title>
|
---|
| 53 |
|
---|
| 54 | <varlistentry>
|
---|
| 55 | <term><envar>PYTHONPATH=src</envar></term>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>Allow using this package (not installed yet) to build a
|
---|
| 58 | wheel archive for itself, to avoid a chicken-or-egg problem.</para>
|
---|
| 59 | </listitem>
|
---|
| 60 | </varlistentry>
|
---|
| 61 |
|
---|
| 62 | <varlistentry>
|
---|
| 63 | <term><command>wheel</command></term>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>Build wheel archive for this package.</para>
|
---|
| 66 | </listitem>
|
---|
| 67 | </varlistentry>
|
---|
| 68 |
|
---|
| 69 | <varlistentry>
|
---|
| 70 | <term><parameter>-w dist</parameter></term>
|
---|
| 71 | <listitem>
|
---|
| 72 | <para>Put the created wheels into the
|
---|
| 73 | <filename class='directory'>dist</filename> directory.</para>
|
---|
| 74 | </listitem>
|
---|
| 75 | </varlistentry>
|
---|
[5a2aca5] | 76 |
|
---|
| 77 | <varlistentry>
|
---|
| 78 | <term><command>install</command></term>
|
---|
| 79 | <listitem>
|
---|
[ee16e55] | 80 | <para>Install the package.</para>
|
---|
[5a2aca5] | 81 | </listitem>
|
---|
| 82 | </varlistentry>
|
---|
| 83 |
|
---|
| 84 | <varlistentry>
|
---|
[e3187f4] | 85 | <term><parameter>--no-build-isolation</parameter>,
|
---|
| 86 | <parameter>--no-deps</parameter>, and
|
---|
| 87 | <parameter>--no-index</parameter></term>
|
---|
[5a2aca5] | 88 | <listitem>
|
---|
| 89 | <para>Prevent pip from fetching files from the online package
|
---|
| 90 | repository (PyPI). If packages are installed in the correct order,
|
---|
[e3187f4] | 91 | then it won't need to fetch any files in the first place, but these
|
---|
| 92 | options add some safety in case of user error.</para>
|
---|
[5a2aca5] | 93 | </listitem>
|
---|
| 94 | </varlistentry>
|
---|
| 95 |
|
---|
| 96 | <varlistentry>
|
---|
[e3187f4] | 97 | <term><parameter>--find-links dist</parameter></term>
|
---|
[5a2aca5] | 98 | <listitem>
|
---|
[e3187f4] | 99 | <para>Search wheel archives from the
|
---|
| 100 | <filename class='directory'>dist</filename> directory.</para>
|
---|
[5a2aca5] | 101 | </listitem>
|
---|
| 102 | </varlistentry>
|
---|
| 103 | </variablelist>
|
---|
| 104 | </sect2>
|
---|
| 105 |
|
---|
| 106 | <sect2 id="contents-wheel" role="content">
|
---|
| 107 | <title>Contents of Wheel</title>
|
---|
| 108 |
|
---|
| 109 | <segmentedlist>
|
---|
[ee16e55] | 110 | <segtitle>Installed program</segtitle>
|
---|
[3094b8c] | 111 | <segtitle>Installed directories</segtitle>
|
---|
[5a2aca5] | 112 |
|
---|
| 113 | <seglistitem>
|
---|
[ee16e55] | 114 | <seg>wheel</seg>
|
---|
[3094b8c] | 115 | <seg>
|
---|
| 116 | /usr/lib/python&python-minor;/site-packages/wheel and
|
---|
[e3187f4] | 117 | /usr/lib/python&python-minor;/site-packages/wheel-&wheel-version;.dist-info
|
---|
[3094b8c] | 118 | </seg>
|
---|
[5a2aca5] | 119 | </seglistitem>
|
---|
| 120 | </segmentedlist>
|
---|
| 121 |
|
---|
[ee16e55] | 122 | <variablelist>
|
---|
| 123 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 124 | <?dbfo list-presentation="list"?>
|
---|
| 125 | <?dbhtml list-presentation="table"?>
|
---|
| 126 |
|
---|
| 127 | <varlistentry id="wheel-wheel">
|
---|
| 128 | <term><command>wheel</command></term>
|
---|
| 129 | <listitem>
|
---|
| 130 | <para>
|
---|
| 131 | is an utility to unpack, pack, or convert wheel packages
|
---|
| 132 | </para>
|
---|
| 133 | <indexterm zone="ch-system-wheel">
|
---|
| 134 | <primary sortas="b-wheel">wheel</primary>
|
---|
| 135 | </indexterm>
|
---|
| 136 | </listitem>
|
---|
| 137 | </varlistentry>
|
---|
| 138 | </variablelist>
|
---|
| 139 |
|
---|
[5a2aca5] | 140 | </sect2>
|
---|
| 141 |
|
---|
| 142 | </sect1>
|
---|
| 143 |
|
---|