[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 " ">
|
---|
[234bc845] | 9 | <!ENTITY attrs-md5sum "&attrs-md5sum;">
|
---|
| 10 | <!ENTITY attrs-size "776 KB">
|
---|
| 11 | <!ENTITY attrs-buildsize "7 MB (add 78 MB for tests)">
|
---|
[b112f043] | 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>
|
---|
[e343b67] | 27 | The <application>Attrs</application> package is a python module
|
---|
| 28 | that allows for writing attributes without extra boilerplate.
|
---|
[25ee667] | 29 | </para>
|
---|
| 30 |
|
---|
[09ddf35a] | 31 | &lfs122_checked;
|
---|
[25ee667] | 32 |
|
---|
| 33 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 34 | <itemizedlist spacing="compact">
|
---|
| 35 | <listitem>
|
---|
| 36 | <para>
|
---|
| 37 | Download (HTTP): <ulink url="&attrs-download-http;"/>
|
---|
| 38 | </para>
|
---|
| 39 | </listitem>
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (FTP): <ulink url="&attrs-download-ftp;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download MD5 sum: &attrs-md5sum;
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download size: &attrs-size;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Estimated disk space required: &attrs-buildsize;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated build time: &attrs-time;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | </itemizedlist>
|
---|
| 66 |
|
---|
[f5096a7d] | 67 | <bridgehead renderas="sect4">Attrs Dependencies</bridgehead>
|
---|
[1037704b] | 68 |
|
---|
| 69 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
| 70 | <para role='required'>
|
---|
[47ad3d0] | 71 | <xref linkend='hatch-fancy-pypi-readme'/> and
|
---|
[1037704b] | 72 | <xref linkend='hatch-vcs'/>
|
---|
| 73 | </para>
|
---|
| 74 |
|
---|
[114f6db9] | 75 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
| 76 | <para role="optional">
|
---|
| 77 | <xref linkend="pytest"/>,
|
---|
[1037704b] | 78 | <ulink url="https://pypi.org/project/cloudpickle/">cloudpickle</ulink>,
|
---|
[114f6db9] | 79 | <ulink url="https://pypi.org/project/hypothesis/">hypothesis</ulink>,
|
---|
| 80 | <ulink url="https://pypi.org/project/Pympler/">Pympler</ulink>,
|
---|
[234bc845] | 81 | <ulink url="https://pypi.org/project/mypy/">mypy</ulink>,
|
---|
[114f6db9] | 82 | <ulink url="https://pypi.org/project/pytest-mypy-plugins/">pytest-mypy-plugins</ulink>,
|
---|
[1037704b] | 83 | <ulink url="https://pypi.org/project/pytest-xdist/">pytest-xdist[psutil]</ulink>, and
|
---|
| 84 | <ulink url="https://pypi.org/project/zope.interface/">zope.interface</ulink>
|
---|
[114f6db9] | 85 | </para>
|
---|
| 86 |
|
---|
[25ee667] | 87 | </sect3>
|
---|
| 88 |
|
---|
| 89 | <sect3 role="installation">
|
---|
| 90 | <title>Installation of Attrs</title>
|
---|
| 91 |
|
---|
| 92 | <para>Build the module: </para>
|
---|
| 93 |
|
---|
[082e722] | 94 | &build-wheel;
|
---|
[25ee667] | 95 |
|
---|
| 96 | <para>
|
---|
[114f6db9] | 97 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
[25ee667] | 98 | </para>
|
---|
| 99 |
|
---|
[082e722] | 100 | <screen role="root"><userinput>&install-wheel; attrs</userinput></screen>
|
---|
[114f6db9] | 101 |
|
---|
[25ee667] | 102 | <para>
|
---|
[114f6db9] | 103 | To test the installation, run:
|
---|
[25ee667] | 104 | </para>
|
---|
| 105 |
|
---|
[1037704b] | 106 | <screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &&
|
---|
[234bc845] | 107 | testenv/bin/pip3 install 'attrs[tests]' &&
|
---|
[1037704b] | 108 | PATH=$PWD/testenv/bin:$PATH testenv/bin/python -m pytest</userinput></screen>
|
---|
| 109 |
|
---|
[25ee667] | 110 | </sect3>
|
---|
| 111 |
|
---|
| 112 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 113 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 114 |
|
---|
| 115 | <sect3 role="content">
|
---|
| 116 | <title>Contents</title>
|
---|
| 117 |
|
---|
| 118 | <segmentedlist>
|
---|
| 119 | <segtitle>Installed Programs</segtitle>
|
---|
| 120 | <segtitle>Installed Libraries</segtitle>
|
---|
| 121 | <segtitle>Installed Directories</segtitle>
|
---|
| 122 |
|
---|
| 123 | <seglistitem>
|
---|
| 124 | <seg>None</seg>
|
---|
| 125 | <seg>None</seg>
|
---|
| 126 | <seg>
|
---|
| 127 | /usr/lib/python&python3-majorver;/site-packages/attr,
|
---|
| 128 | /usr/lib/python&python3-majorver;/site-packages/attrs, and
|
---|
| 129 | /usr/lib/python&python3-majorver;/site-packages/attrs-&attrs-version;.dist-info
|
---|
| 130 | </seg>
|
---|
| 131 | </seglistitem>
|
---|
| 132 | </segmentedlist>
|
---|
| 133 |
|
---|
| 134 | </sect3>
|
---|
| 135 |
|
---|
| 136 | </sect2>
|
---|