source: general/prog/python-dependencies/trove-classifiers.xml

<?xml version="1.0" encoding="UTF-8"?>
<!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 trove-classifiers-download-http "https://files.pythonhosted.org/packages/source/t/trove_classifiers/trove-classifiers-&trove-classifiers-version;.tar.gz">
  <!ENTITY trove-classifiers-download-ftp  " ">
  <!ENTITY trove-classifiers-md5sum        "&trove-classifiers-md5sum;">
  <!ENTITY trove-classifiers-size          "16 KB">
  <!ENTITY trove-classifiers-buildsize     "276 KB">
  <!ENTITY trove-classifiers-time          "less than 0.1 SBU">
]>

  <sect2 id="trove-classifiers" xreflabel="trove-classifiers-&trove-classifiers-version;">

    <title>Trove-Classifiers-&trove-classifiers-version;</title>

    <indexterm zone="trove-classifiers">
      <primary sortas="a-trove-classifiers">trove-classifiers</primary>
    </indexterm>

    <sect3 role="package">
      <title>Introduction to Trove-Classifiers Module</title>

      <para>
        <application>Trove-Classifiers</application> is a Python library
        to encompass all valid PyPI classifiers used to categorize projects
        and releases per PEP 301, for example
        <literal>Topic :: System :: Filesystems</literal> and
        <literal>Development Status :: 6 - Mature</literal>.
      </para>

      &lfs121_checked;

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

      <bridgehead renderas="sect4">Trove-Classifiers Dependencies</bridgehead>

      <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
      <para role="optional">
        <xref linkend="pytest"/>
      </para>
    </sect3>

    <sect3 role="installation">
      <title>Installation of Trove-Classifiers</title>

    <para>
      First, hard code the package version into
      <filename>setup.py</filename> to work around an issue causing the
      generated wheel contain incorrect version string when the
      <application>calver</application> module is not installed:
    </para>

<screen><userinput>sed '/calver/s/^/#/;$iversion="&trove-classifiers-version;"' \
    -i setup.py</userinput></screen>

    <para>Build the module: </para>

&build-wheel;

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

<screen role="root"><userinput>&install-wheel; trove-classifiers</userinput></screen>

    <para>
      To test the installation, issue: <command>pytest</command>.
    </para>

    </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/trove_classifiers and
            /usr/lib/python&python3-majorver;/site-packages/trove_classifiers-&trove-classifiers-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>