source: general/prog/python-dependencies/attrs.xml@ c8c80645

<?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 attrs-download-http "https://files.pythonhosted.org/packages/source/a/attrs/attrs-&attrs-version;.tar.gz">
  <!ENTITY attrs-download-ftp  " ">
  <!ENTITY attrs-md5sum        "eff16b3bbd0d9b72e118cca83a19d380">
  <!ENTITY attrs-size          "211 KB">
  <!ENTITY attrs-buildsize     "2 MB (add 53 MB for tests)">
  <!ENTITY attrs-time          "less than 0.1 SBU (0.2 SBU for tests)">
]>

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

    <title>Attrs-&attrs-version;</title>

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

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

      <para>
        The <application>Attrs</application> package is a theme for
        the <application>sphinx</application> documentation system. Although
        developed separately, it is the default theme for sphinx.
      </para>

      &lfs121_checked;

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

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

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role='required'>
<!--        <xref linkend='hatch-fancy-pypi-readme'/> and-->
        <xref linkend='hatch-vcs'/>
      </para>

      <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
      <para role="optional">
        <xref linkend="pytest"/>,
        <ulink url="https://pypi.org/project/cloudpickle/">cloudpickle</ulink>,
        <ulink url="https://pypi.org/project/hypothesis/">hypothesis</ulink>,
        <ulink url="https://pypi.org/project/Pympler/">Pympler</ulink>,
        <!-- Upstream wants "< 1.10" for this one:
             https://github.com/python-attrs/attrs/commit/46f1f35896e9 -->
        <ulink url="https://pypi.org/project/mypy/">mypy &lt; 1.10</ulink>,
        <ulink url="https://pypi.org/project/pytest-mypy-plugins/">pytest-mypy-plugins</ulink>,
        <ulink url="https://pypi.org/project/pytest-xdist/">pytest-xdist[psutil]</ulink>, and
        <ulink url="https://pypi.org/project/zope.interface/">zope.interface</ulink>
      </para>

    </sect3>

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

    <para>Build the module: </para>

&build-wheel;

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

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

    <para>
      To test the installation, run:
    </para>

<screen remap="test"><userinput>python3 -m venv --system-site-packages testenv           &amp;&amp;
testenv/bin/pip3 install 'attrs[tests]' 'mypy &lt; 1.10'    &amp;&amp;
PATH=$PWD/testenv/bin:$PATH testenv/bin/python -m pytest</userinput></screen>

    <!-- https://github.com/python-attrs/attrs/pull/1249 -->
    <para>
      One test named <literal>TestAssoc::test_unknown</literal> is known
      to fail with pytest-8.0.0 or later.
    </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/attr,
            /usr/lib/python&python3-majorver;/site-packages/attrs, and
            /usr/lib/python&python3-majorver;/site-packages/attrs-&attrs-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>