source: general/prog/python-dependencies/flit_core.xml@ 3d42149

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect2 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;

  <!ENTITY flit_core-download-http "https://files.pythonhosted.org/packages/source/f/flit_core/flit_core-&flit_core-version;.tar.gz">
  <!ENTITY flit_core-download-ftp  " ">
  <!ENTITY flit_core-md5sum        "4a4791e97f3a8c9a1645064a35636ee6">
  <!ENTITY flit_core-size          "39 KB">
  <!ENTITY flit_core-buildsize     "1.7 MB (add 25 MB for tests)">
  <!ENTITY flit_core-time          "less than 0.1 SBU (with tests)">
]>

  <sect2 id="flit_core" xreflabel="flit_core-&flit_core-version;">

    <title>Flit_core-&flit_core-version;</title>

    <indexterm zone="flit_core">
      <primary sortas="a-flit_core">flit_core</primary>
    </indexterm>

    <sect3 role="package">
      <title>Introduction to Flit_core Module</title>

      <para>
        The <application>Flit_core</application> module is the key component
        of the <application>Flit</application> system, which provides a
        simple way to put Python packages and modules on PyPi.
      </para>

      &lfs112_checked;

      <bridgehead renderas="sect4">Package Information</bridgehead>
      <itemizedlist spacing="compact">
        <listitem>
          <para>
            Download (HTTP): <ulink url="&flit_core-download-http;"/>
          </para>
        </listitem>
        <listitem>
          <para>
            Download (FTP): <ulink url="&flit_core-download-ftp;"/>
          </para>
        </listitem>
        <listitem>
          <para>
            Download MD5 sum: &flit_core-md5sum;
          </para>
        </listitem>
        <listitem>
          <para>
            Download size: &flit_core-size;
          </para>
        </listitem>
        <listitem>
          <para>
            Estimated disk space required: &flit_core-buildsize;
          </para>
        </listitem>
        <listitem>
          <para>
            Estimated build time: &flit_core-time;
          </para>
        </listitem>
      </itemizedlist>

      <bridgehead renderas="sect4">Flit_core Dependencies</bridgehead>

      <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
      <para role="optional">
        <xref linkend="pytest"/> and
        <ulink url="https://pypi.org/project/testpath/">testpath</ulink>
      </para>

    </sect3>

    <sect3 role="installation">
      <title>Installation of Flit_core</title>

      <para>
        Build the module:
      </para>

<screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>pip3 install --no-index --find-links dist --no-cache-dir --no-user flit_core</userinput></screen>

    <para>
      Assuming <xref linkend="pytest"/> is installed, but the other optional
      dependency is not, the installation can be tested with the following
      commands:
    </para>

<screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &amp;&amp;
source testenv/bin/activate                    &amp;&amp;
pip3 install testpath                          &amp;&amp;
python3 /usr/bin/pytest<!-- no && in case there is an error -->
deactivate</userinput></screen>

    </sect3>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../../xincludes/pip3-cmd-explain.xml"/>

    <sect3 role="content">
      <title>Contents</title>

      <segmentedlist>
        <segtitle>Installed Programs</segtitle>
        <segtitle>Installed Libraries</segtitle>
        <segtitle>Installed Directories</segtitle>

        <seglistitem>
          <seg>None</seg>
          <seg>None</seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/flit_core and
            /usr/lib/python&python3-majorver;/site-packages/flit_core-&flit_core-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>