[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[25ee667] | 2 | <!DOCTYPE sect2 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 |
|
---|
[301c411] | 7 | <!ENTITY attrs-download-http "https://files.pythonhosted.org/packages/source/a/attrs/attrs-&attrs-version;.tar.gz">
|
---|
[25ee667] | 8 | <!ENTITY attrs-download-ftp " ">
|
---|
[8f65da99] | 9 | <!ENTITY attrs-md5sum "eff16b3bbd0d9b72e118cca83a19d380">
|
---|
| 10 | <!ENTITY attrs-size "211 KB">
|
---|
[b112f043] | 11 | <!ENTITY attrs-buildsize "2 MB (add 53 MB for tests)">
|
---|
| 12 | <!ENTITY attrs-time "less than 0.1 SBU (0.2 SBU for tests)">
|
---|
[25ee667] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect2 id="attrs" xreflabel="attrs-&attrs-version;">
|
---|
| 16 |
|
---|
| 17 | <title>Attrs-&attrs-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="attrs">
|
---|
| 20 | <primary sortas="a-attrs">attrs</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect3 role="package">
|
---|
| 24 | <title>Introduction to Attrs Module</title>
|
---|
| 25 |
|
---|
| 26 | <para>
|
---|
| 27 | The <application>Attrs</application> package is a theme for
|
---|
| 28 | the <application>sphinx</application> documentation system. Although
|
---|
| 29 | developed separately, it is the default theme for sphinx.
|
---|
| 30 | </para>
|
---|
| 31 |
|
---|
[e8b3f50] | 32 | &lfs121_checked;
|
---|
[25ee667] | 33 |
|
---|
| 34 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 35 | <itemizedlist spacing="compact">
|
---|
| 36 | <listitem>
|
---|
| 37 | <para>
|
---|
| 38 | Download (HTTP): <ulink url="&attrs-download-http;"/>
|
---|
| 39 | </para>
|
---|
| 40 | </listitem>
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (FTP): <ulink url="&attrs-download-ftp;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download MD5 sum: &attrs-md5sum;
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download size: &attrs-size;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Estimated disk space required: &attrs-buildsize;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated build time: &attrs-time;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | </itemizedlist>
|
---|
| 67 |
|
---|
[f5096a7d] | 68 | <bridgehead renderas="sect4">Attrs Dependencies</bridgehead>
|
---|
[1037704b] | 69 |
|
---|
| 70 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
| 71 | <para role='required'>
|
---|
[c8c80645] | 72 | <!-- <xref linkend='hatch-fancy-pypi-readme'/> and-->
|
---|
[1037704b] | 73 | <xref linkend='hatch-vcs'/>
|
---|
| 74 | </para>
|
---|
| 75 |
|
---|
[114f6db9] | 76 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
| 77 | <para role="optional">
|
---|
| 78 | <xref linkend="pytest"/>,
|
---|
[1037704b] | 79 | <ulink url="https://pypi.org/project/cloudpickle/">cloudpickle</ulink>,
|
---|
[114f6db9] | 80 | <ulink url="https://pypi.org/project/hypothesis/">hypothesis</ulink>,
|
---|
| 81 | <ulink url="https://pypi.org/project/Pympler/">Pympler</ulink>,
|
---|
[1037704b] | 82 | <!-- Upstream wants "< 1.10" for this one:
|
---|
| 83 | https://github.com/python-attrs/attrs/commit/46f1f35896e9 -->
|
---|
| 84 | <ulink url="https://pypi.org/project/mypy/">mypy < 1.10</ulink>,
|
---|
[114f6db9] | 85 | <ulink url="https://pypi.org/project/pytest-mypy-plugins/">pytest-mypy-plugins</ulink>,
|
---|
[1037704b] | 86 | <ulink url="https://pypi.org/project/pytest-xdist/">pytest-xdist[psutil]</ulink>, and
|
---|
| 87 | <ulink url="https://pypi.org/project/zope.interface/">zope.interface</ulink>
|
---|
[114f6db9] | 88 | </para>
|
---|
| 89 |
|
---|
[25ee667] | 90 | </sect3>
|
---|
| 91 |
|
---|
| 92 | <sect3 role="installation">
|
---|
| 93 | <title>Installation of Attrs</title>
|
---|
| 94 |
|
---|
| 95 | <para>Build the module: </para>
|
---|
| 96 |
|
---|
[082e722] | 97 | &build-wheel;
|
---|
[25ee667] | 98 |
|
---|
| 99 | <para>
|
---|
[114f6db9] | 100 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
[25ee667] | 101 | </para>
|
---|
| 102 |
|
---|
[082e722] | 103 | <screen role="root"><userinput>&install-wheel; attrs</userinput></screen>
|
---|
[114f6db9] | 104 |
|
---|
[25ee667] | 105 | <para>
|
---|
[114f6db9] | 106 | To test the installation, run:
|
---|
[25ee667] | 107 | </para>
|
---|
| 108 |
|
---|
[1037704b] | 109 | <screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &&
|
---|
| 110 | testenv/bin/pip3 install 'attrs[tests]' 'mypy < 1.10' &&
|
---|
| 111 | PATH=$PWD/testenv/bin:$PATH testenv/bin/python -m pytest</userinput></screen>
|
---|
| 112 |
|
---|
| 113 | <!-- https://github.com/python-attrs/attrs/pull/1249 -->
|
---|
| 114 | <para>
|
---|
| 115 | One test named <literal>TestAssoc::test_unknown</literal> is known
|
---|
| 116 | to fail with pytest-8.0.0 or later.
|
---|
| 117 | </para>
|
---|
[25ee667] | 118 |
|
---|
| 119 | </sect3>
|
---|
| 120 |
|
---|
| 121 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 122 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 123 |
|
---|
| 124 | <sect3 role="content">
|
---|
| 125 | <title>Contents</title>
|
---|
| 126 |
|
---|
| 127 | <segmentedlist>
|
---|
| 128 | <segtitle>Installed Programs</segtitle>
|
---|
| 129 | <segtitle>Installed Libraries</segtitle>
|
---|
| 130 | <segtitle>Installed Directories</segtitle>
|
---|
| 131 |
|
---|
| 132 | <seglistitem>
|
---|
| 133 | <seg>None</seg>
|
---|
| 134 | <seg>None</seg>
|
---|
| 135 | <seg>
|
---|
| 136 | /usr/lib/python&python3-majorver;/site-packages/attr,
|
---|
| 137 | /usr/lib/python&python3-majorver;/site-packages/attrs, and
|
---|
| 138 | /usr/lib/python&python3-majorver;/site-packages/attrs-&attrs-version;.dist-info
|
---|
| 139 | </seg>
|
---|
| 140 | </seglistitem>
|
---|
| 141 | </segmentedlist>
|
---|
| 142 |
|
---|
| 143 | </sect3>
|
---|
| 144 |
|
---|
| 145 | </sect2>
|
---|