source: general/prog/python-dependencies/setuptools_scm.xml@ 569925c7

<?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 setuptools_scm-download-http "https://files.pythonhosted.org/packages/source/s/setuptools_scm/setuptools_scm-&setuptools_scm-version;.tar.gz">
  <!ENTITY setuptools_scm-download-ftp  " ">
  <!ENTITY setuptools_scm-md5sum        "&setuptools_scm-md5sum;">
  <!ENTITY setuptools_scm-size          "70 KB">
  <!ENTITY setuptools_scm-buildsize     "1.6 MB (with tests)">
  <!ENTITY setuptools_scm-time          "less than 0.1 SBU (add 0.4 SBU for tests)">
]>

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

    <title>Setuptools_scm-&setuptools_scm-version;</title>

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

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

      <para>
        The <application>Setuptools_scm</application> package is used to
        extract Python package versions from git or hg metadata instead
        of declaring them.
      </para>

      &lfs112_checked;

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

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

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="packaging"/> and
        <xref linkend="typing_extensions"/>
      </para>

      <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
      <para role="optional">
        <xref linkend="git"/>,
        <xref linkend="mercurial"/>, and
        <xref linkend="pytest"/>
      </para>

    </sect3>

    <sect3 role="installation">
      <title>Installation of Setuptools_scm</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 setuptools_scm</userinput></screen>

    <para>
      The installtion can be tested with <command>pytest</command>. A few
      tests may fail if your <application>git</application> configuration
      is not the one expected by the test suite.
    </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/setuptools_scm and
            /usr/lib/python&python3-majorver;/site-packages/setuptools_scm-&setuptools_scm-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>