[7152faa] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[af612e9a] | 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 |
|
---|
[fd531b84] | 8 | <sect1 id="ch-system-flit-core" role="wrap">
|
---|
[af612e9a] | 9 | <?dbhtml filename="flit-core.html"?>
|
---|
| 10 |
|
---|
| 11 | <sect1info condition="script">
|
---|
| 12 | <productname>flit-core</productname>
|
---|
| 13 | <productnumber>&flit-core-version;</productnumber>
|
---|
| 14 | <address>&flit-core-url;</address>
|
---|
| 15 | </sect1info>
|
---|
| 16 |
|
---|
| 17 | <title>Flit-Core-&flit-core-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="ch-system-flit-core">
|
---|
| 20 | <primary sortas="a-flit-core">Flit-core</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect2 role="package">
|
---|
| 24 | <title/>
|
---|
| 25 |
|
---|
| 26 | <para>Flit-core is the distribution-building parts of Flit (a packaging
|
---|
| 27 | tool for simple Python modules).</para>
|
---|
| 28 |
|
---|
| 29 | <segmentedlist>
|
---|
| 30 | <segtitle>&buildtime;</segtitle>
|
---|
| 31 | <segtitle>&diskspace;</segtitle>
|
---|
| 32 | <seglistitem>
|
---|
| 33 | <seg>&flit-core-fin-sbu;</seg>
|
---|
| 34 | <seg>&flit-core-fin-du;</seg>
|
---|
| 35 | </seglistitem>
|
---|
| 36 | </segmentedlist>
|
---|
| 37 |
|
---|
| 38 | </sect2>
|
---|
| 39 |
|
---|
| 40 | <sect2 role="installation">
|
---|
[4e3fe1d] | 41 | <title>Installation of Flit-Core</title>
|
---|
[af612e9a] | 42 |
|
---|
| 43 | <para>Build the package:</para>
|
---|
| 44 |
|
---|
[1b80763] | 45 | <screen><userinput remap="install">pip3 wheel -w dist --no-cache-dir --no-build-isolation --no-deps $PWD</userinput></screen>
|
---|
[af612e9a] | 46 |
|
---|
| 47 | <para>Install the package:</para>
|
---|
| 48 |
|
---|
| 49 | <screen><userinput remap="install">pip3 install --no-index --no-user --find-links dist flit_core</userinput></screen>
|
---|
| 50 |
|
---|
| 51 | <variablelist>
|
---|
| 52 | <title>The meaning of the pip3 configuration options and commands:</title>
|
---|
| 53 |
|
---|
| 54 | <varlistentry>
|
---|
| 55 | <term><command>wheel</command></term>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>This command builds the wheel archive for this package.</para>
|
---|
| 58 | </listitem>
|
---|
| 59 | </varlistentry>
|
---|
| 60 |
|
---|
| 61 | <varlistentry>
|
---|
| 62 | <term><parameter>-w dist</parameter></term>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>Instructs pip to put the created wheel into the
|
---|
| 65 | <filename class='directory'>dist</filename> directory.</para>
|
---|
| 66 | </listitem>
|
---|
| 67 | </varlistentry>
|
---|
| 68 |
|
---|
[1b80763] | 69 | <varlistentry>
|
---|
| 70 | <term><parameter>--no-cache-dir</parameter></term>
|
---|
| 71 | <listitem>
|
---|
| 72 | <para>Prevents pip from copying the created wheel into the
|
---|
| 73 | <filename class='directory'>/root/.cache/pip</filename>
|
---|
| 74 | directory.</para>
|
---|
| 75 | </listitem>
|
---|
| 76 | </varlistentry>
|
---|
| 77 |
|
---|
[af612e9a] | 78 | <varlistentry>
|
---|
| 79 | <term><command>install</command></term>
|
---|
| 80 | <listitem>
|
---|
| 81 | <para>This command installs the package.</para>
|
---|
| 82 | </listitem>
|
---|
| 83 | </varlistentry>
|
---|
| 84 |
|
---|
| 85 | <varlistentry>
|
---|
| 86 | <term><parameter>--no-build-isolation</parameter>,
|
---|
| 87 | <parameter>--no-deps</parameter>, and
|
---|
| 88 | <parameter>--no-index</parameter></term>
|
---|
| 89 | <listitem>
|
---|
| 90 | <para>These options prevent fetching files from the online package
|
---|
| 91 | repository (PyPI). If packages are installed in the correct order,
|
---|
| 92 | pip won't need to fetch any files in the first place; these
|
---|
| 93 | options add some safety in case of user error.</para>
|
---|
| 94 | </listitem>
|
---|
| 95 | </varlistentry>
|
---|
| 96 |
|
---|
| 97 | <varlistentry>
|
---|
| 98 | <term><parameter>--find-links dist</parameter></term>
|
---|
| 99 | <listitem>
|
---|
| 100 | <para>Instructs pip to search for wheel archives in the
|
---|
| 101 | <filename class='directory'>dist</filename> directory.</para>
|
---|
| 102 | </listitem>
|
---|
| 103 | </varlistentry>
|
---|
| 104 | </variablelist>
|
---|
| 105 | </sect2>
|
---|
| 106 |
|
---|
| 107 | <sect2 id="contents-flit-core" role="content">
|
---|
| 108 | <title>Contents of Flit-Core</title>
|
---|
| 109 |
|
---|
| 110 | <segmentedlist>
|
---|
| 111 | <segtitle>Installed directory</segtitle>
|
---|
| 112 |
|
---|
| 113 | <seglistitem>
|
---|
| 114 | <seg>
|
---|
| 115 | /usr/lib/python&python-minor;/site-packages/flit_core and
|
---|
| 116 | /usr/lib/python&python-minor;/site-packages/flit_core-&flit-core-version;.dist-info
|
---|
| 117 | </seg>
|
---|
| 118 | </seglistitem>
|
---|
| 119 | </segmentedlist>
|
---|
| 120 |
|
---|
| 121 | </sect2>
|
---|
| 122 |
|
---|
| 123 | </sect1>
|
---|
| 124 |
|
---|