glfs/general/prog/python-dependencies/hatch-vcs.xml
Bruce Dubbs 569925c77f Update python modules for pythonhosted
Move the pythonhoted page to python_modules even though it is not
yet activated to render in the book.

Change location of pythonhosted md5sum ENTITIES to packages.ent
so they can be used in multiple pages but only need to be updated
in one place.

Note that pages not have entries like:
  <!ENTITY asciidoc-md5sum        "&asciidoc-md5sum;">
so this seems to be redefinig the entity to the version
in packages.ent.  This seems to be OK with the build system.
2023-01-31 18:02:12 -06:00

126 lines
3.7 KiB
XML

<?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 hatch-vcs-download-http "https://files.pythonhosted.org/packages/source/h/hatch-vcs/hatch_vcs-&hatch-vcs-version;.tar.gz">
<!ENTITY hatch-vcs-download-ftp " ">
<!ENTITY hatch-vcs-md5sum "&hatch-vcs-md5sum;">
<!ENTITY hatch-vcs-size "9.9 KB">
<!ENTITY hatch-vcs-buildsize "436 KB (with tests)">
<!ENTITY hatch-vcs-time "less than 0.1 SBU (with tests)">
]>
<sect2 id="hatch-vcs" xreflabel="hatch_vcs-&hatch-vcs-version;">
<title>Hatch_vcs-&hatch-vcs-version;</title>
<indexterm zone="hatch-vcs">
<primary sortas="a-hatch_vcs">hatch_vcs</primary>
</indexterm>
<sect3 role="package">
<title>Introduction to Hatch-vcs Module</title>
<para>
<application>Hatch_vcs</application> is a Hatch plugin for versioning
with several <xref linkend="gVCS"/>.
</para>
&lfs112_checked;
<bridgehead renderas="sect4">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&hatch-vcs-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&hatch-vcs-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &hatch-vcs-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &hatch-vcs-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &hatch-vcs-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &hatch-vcs-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect4">Hatch_vcs Dependencies</bridgehead>
<bridgehead renderas="sect5">Required</bridgehead>
<para role="required">
<xref linkend="hatchling"/> and
<xref linkend="setuptools_scm"/>
</para>
<bridgehead renderas="sect5">Optional (for testing)</bridgehead>
<para role="optional">
<xref linkend="pytest"/>
</para>
</sect3>
<sect3 role="installation">
<title>Installation of Hatch_vcs</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 hatch_vcs</userinput></screen>
<para>
To test the installation, issue <command>pytest</command>. One test
fails.
</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/hatch_vcs and
/usr/lib/python&python3-majorver;/site-packages/hatch_vcs-&hatch-vcs-version;.dist-info
</seg>
</seglistitem>
</segmentedlist>
</sect3>
</sect2>