[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 |
|
---|
[8455183] | 7 | <!ENTITY setuptools_scm-download-http "https://files.pythonhosted.org/packages/source/s/setuptools_scm/setuptools_scm-&setuptools_scm-version;.tar.gz">
|
---|
[25ee667] | 8 | <!ENTITY setuptools_scm-download-ftp " ">
|
---|
[569925c7] | 9 | <!ENTITY setuptools_scm-md5sum "&setuptools_scm-md5sum;">
|
---|
[8f65da99] | 10 | <!ENTITY setuptools_scm-size "70 KB">
|
---|
[b112f043] | 11 | <!ENTITY setuptools_scm-buildsize "1.6 MB (with tests)">
|
---|
| 12 | <!ENTITY setuptools_scm-time "less than 0.1 SBU (add 0.4 SBU for tests)">
|
---|
[25ee667] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect2 id="setuptools_scm" xreflabel="setuptools_scm-&setuptools_scm-version;">
|
---|
| 16 |
|
---|
| 17 | <title>Setuptools_scm-&setuptools_scm-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="setuptools_scm">
|
---|
| 20 | <primary sortas="a-setuptools_scm">setuptools_scm</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect3 role="package">
|
---|
| 24 | <title>Introduction to Setuptools_scm Module</title>
|
---|
| 25 |
|
---|
| 26 | <para>
|
---|
| 27 | The <application>Setuptools_scm</application> package is used to
|
---|
| 28 | extract Python package versions from git or hg metadata instead
|
---|
| 29 | of declaring them.
|
---|
| 30 | </para>
|
---|
| 31 |
|
---|
[09ddf35a] | 32 | &lfs122_checked;
|
---|
[25ee667] | 33 |
|
---|
| 34 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 35 | <itemizedlist spacing="compact">
|
---|
| 36 | <listitem>
|
---|
| 37 | <para>
|
---|
| 38 | Download (HTTP): <ulink url="&setuptools_scm-download-http;"/>
|
---|
| 39 | </para>
|
---|
| 40 | </listitem>
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (FTP): <ulink url="&setuptools_scm-download-ftp;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download MD5 sum: &setuptools_scm-md5sum;
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download size: &setuptools_scm-size;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Estimated disk space required: &setuptools_scm-buildsize;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated build time: &setuptools_scm-time;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | </itemizedlist>
|
---|
| 67 |
|
---|
| 68 | <bridgehead renderas="sect4">Setuptools_scm Dependencies</bridgehead>
|
---|
| 69 |
|
---|
| 70 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
| 71 | <para role="required">
|
---|
[8455183] | 72 | <xref linkend="packaging"/>
|
---|
[25ee667] | 73 | </para>
|
---|
| 74 |
|
---|
[74434cc] | 75 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
| 76 | <para role="optional">
|
---|
| 77 | <xref linkend="git"/>,
|
---|
[f5096a7d] | 78 | <xref linkend="mercurial"/>,
|
---|
| 79 | <xref linkend="pytest"/>,
|
---|
| 80 | <xref linkend="sudo"/>, and
|
---|
| 81 | <ulink url="https://pypi.org/project/build/">build</ulink>
|
---|
[74434cc] | 82 | </para>
|
---|
| 83 |
|
---|
[25ee667] | 84 | </sect3>
|
---|
| 85 |
|
---|
| 86 | <sect3 role="installation">
|
---|
| 87 | <title>Installation of Setuptools_scm</title>
|
---|
| 88 |
|
---|
| 89 | <para>Build the module: </para>
|
---|
| 90 |
|
---|
[082e722] | 91 | &build-wheel;
|
---|
[25ee667] | 92 |
|
---|
| 93 | <para>
|
---|
| 94 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 95 | </para>
|
---|
| 96 |
|
---|
[082e722] | 97 | <screen role="root"><userinput>&install-wheel; setuptools_scm</userinput></screen>
|
---|
[25ee667] | 98 |
|
---|
[74434cc] | 99 | <para>
|
---|
[f5096a7d] | 100 | To test the installation, make sure <xref linkend='pytest'/> is
|
---|
[8455183] | 101 | installed and run (<literal>HOME=</literal> prevents the
|
---|
| 102 | <filename>.gitconfig</filename> file in the home directory from
|
---|
| 103 | interfering the tests):
|
---|
[f5096a7d] | 104 | </para>
|
---|
| 105 |
|
---|
| 106 | <screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &&
|
---|
| 107 | testenv/bin/pip3 install build &&
|
---|
[8455183] | 108 | HOME= testenv/bin/python -m pytest</userinput></screen>
|
---|
[f5096a7d] | 109 |
|
---|
| 110 | <para>
|
---|
| 111 | If <xref linkend='git'/> and/or <xref linkend='mercurial'/> are not
|
---|
| 112 | installed, the tests depending on the missing one(s) will be skipped.
|
---|
| 113 | Some tests may invoke <xref linkend='sudo'/> and request a password.
|
---|
[74434cc] | 114 | </para>
|
---|
| 115 |
|
---|
[25ee667] | 116 | </sect3>
|
---|
| 117 |
|
---|
| 118 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 119 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 120 |
|
---|
| 121 | <sect3 role="content">
|
---|
| 122 | <title>Contents</title>
|
---|
| 123 |
|
---|
| 124 | <segmentedlist>
|
---|
| 125 | <segtitle>Installed Programs</segtitle>
|
---|
| 126 | <segtitle>Installed Libraries</segtitle>
|
---|
| 127 | <segtitle>Installed Directories</segtitle>
|
---|
| 128 |
|
---|
| 129 | <seglistitem>
|
---|
| 130 | <seg>None</seg>
|
---|
| 131 | <seg>None</seg>
|
---|
| 132 | <seg>
|
---|
| 133 | /usr/lib/python&python3-majorver;/site-packages/setuptools_scm and
|
---|
| 134 | /usr/lib/python&python3-majorver;/site-packages/setuptools_scm-&setuptools_scm-version;.dist-info
|
---|
| 135 | </seg>
|
---|
| 136 | </seglistitem>
|
---|
| 137 | </segmentedlist>
|
---|
| 138 |
|
---|
| 139 | </sect3>
|
---|
| 140 |
|
---|
| 141 | </sect2>
|
---|