source: chapter08/wheel.xml@ a3ebe8a

11.3 11.3-rc1 12.0 12.0-rc1 12.1 12.1-rc1 12.2 12.2-rc1 bdubbs/gcc13 multilib renodr/libudev-from-systemd trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1 xry111/loongarch-12.2 xry111/mips64el xry111/multilib xry111/update-glibc
Last change on this file since a3ebe8a was a3ebe8a, checked in by David Bryant <davidbryant@…>, 22 months ago

Corrected capitalization of the package name. This was hard to do
because some references appear to refer to the program itself, and
not to the package. Corrected English idiom here and there.

  • Property mode set to 100644
File size: 4.3 KB
Line 
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
17 <title>Wheel-&wheel-version;</title>
18
19 <indexterm zone="ch-system-wheel">
20 <primary sortas="a-wheel">wheel</primary>
21 </indexterm>
22
23 <sect2 role="package">
24 <title/>
25
26 <para>Wheel is a Python library that is the reference
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
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
47 <para>Install Wheel with the following command:</para>
48
49<screen><userinput remap="install">pip3 install --no-index --find-links=dist wheel</userinput></screen>
50
51 <variablelist>
52 <title>The meaning of the pip3 configuration options and commands:</title>
53
54 <varlistentry>
55 <term><envar>PYTHONPATH=src</envar></term>
56 <listitem>
57 <para>Allows 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>This command builds the wheel archive for this package.</para>
66 </listitem>
67 </varlistentry>
68
69 <varlistentry>
70 <term><parameter>-w dist</parameter></term>
71 <listitem>
72 <para>Instructs pip to put the created wheel into the
73 <filename class='directory'>dist</filename> directory.</para>
74 </listitem>
75 </varlistentry>
76
77 <varlistentry>
78 <term><command>install</command></term>
79 <listitem>
80 <para>This command installs the package.</para>
81 </listitem>
82 </varlistentry>
83
84 <varlistentry>
85 <term><parameter>--no-build-isolation</parameter>,
86 <parameter>--no-deps</parameter>, and
87 <parameter>--no-index</parameter></term>
88 <listitem>
89 <para>These options prevent fetching files from the online package
90 repository (PyPI). If packages are installed in the correct order,
91 pip won't need to fetch any files in the first place; these
92 options add some safety in case of user error.</para>
93 </listitem>
94 </varlistentry>
95
96 <varlistentry>
97 <term><parameter>--find-links dist</parameter></term>
98 <listitem>
99 <para>Instructs pip to search for wheel archives in the
100 <filename class='directory'>dist</filename> directory.</para>
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>
110 <segtitle>Installed program</segtitle>
111 <segtitle>Installed directories</segtitle>
112
113 <seglistitem>
114 <seg>wheel</seg>
115 <seg>
116 /usr/lib/python&python-minor;/site-packages/wheel and
117 /usr/lib/python&python-minor;/site-packages/wheel-&wheel-version;.dist-info
118 </seg>
119 </seglistitem>
120 </segmentedlist>
121
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 a utility to unpack, pack, or convert wheel archives
132 </para>
133 <indexterm zone="ch-system-wheel">
134 <primary sortas="b-wheel">wheel</primary>
135 </indexterm>
136 </listitem>
137 </varlistentry>
138 </variablelist>
139
140 </sect2>
141
142</sect1>
143
Note: See TracBrowser for help on using the repository browser.