aboutsummaryrefslogtreecommitdiffstats
path: root/chapter08/wheel.xml
blob: 7ab14426a7dddfd9661b87aaff7dac60e033a5a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../general.ent">
  %general-entities;
]>

<sect1 id="ch-system-wheel" role="wrap">
  <?dbhtml filename="wheel.html"?>

  <sect1info condition="script">
    <productname>wheel</productname>
    <productnumber>&wheel-version;</productnumber>
    <address>&wheel-url;</address>
  </sect1info>

  <title>Wheel-&wheel-version;</title>

  <indexterm zone="ch-system-wheel">
    <primary sortas="a-wheel">wheel</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>Wheel is a Python library that is the reference
    implementation of the Python wheel packaging standard.</para>

    <segmentedlist>
      <segtitle>&buildtime;</segtitle>
      <segtitle>&diskspace;</segtitle>
      <seglistitem>
        <seg>&wheel-fin-sbu;</seg>
        <seg>&wheel-fin-du;</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Wheel</title>

    <para>Compile Wheel with the following command:</para>

<screen><userinput remap="make">PYTHONPATH=src pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>

    <para>Install Wheel with the following command:</para>

<screen><userinput remap="install">pip3 install --no-index --find-links=dist wheel</userinput></screen>

    <variablelist>
      <title>The meaning of the pip3 configuration options and commands:</title>

      <varlistentry>
        <term><envar>PYTHONPATH=src</envar></term>
        <listitem>
           <para>Allows this package (not installed yet) to build a
           wheel archive for itself, to avoid a chicken-or-egg problem.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><command>wheel</command></term>
        <listitem>
           <para>This command builds the wheel archive for this package.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><parameter>-w dist</parameter></term>
        <listitem>
           <para>Instructs pip to put the created wheel into the
           <filename class='directory'>dist</filename> directory.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><command>install</command></term>
        <listitem>
           <para>This command installs the package.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><parameter>--no-build-isolation</parameter>,
              <parameter>--no-deps</parameter>, and
              <parameter>--no-index</parameter></term>
        <listitem>
          <para>These options prevent fetching files from the online package
          repository (PyPI). If packages are installed in the correct order,
          pip won't need to fetch any files in the first place; these
          options add some safety in case of user error.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><parameter>--find-links dist</parameter></term>
        <listitem>
           <para>Instructs pip to search for wheel archives in the
           <filename class='directory'>dist</filename> directory.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

  <sect2 id="contents-wheel" role="content">
    <title>Contents of Wheel</title>

    <segmentedlist>
      <segtitle>Installed program</segtitle>
      <segtitle>Installed directories</segtitle>

      <seglistitem>
        <seg>wheel</seg>
        <seg>
           /usr/lib/python&python-minor;/site-packages/wheel and
           /usr/lib/python&python-minor;/site-packages/wheel-&wheel-version;.dist-info
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="wheel-wheel">
        <term><command>wheel</command></term>
        <listitem>
          <para>
            is a utility to unpack, pack, or convert wheel packages
          </para>
          <indexterm zone="ch-system-wheel">
            <primary sortas="b-wheel">wheel</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>