glfs/general/prog/python-modules/pyparsing.xml
2024-03-07 15:30:43 -06:00

137 lines
4.2 KiB
XML

<?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 pyparsing-download-http "https://files.pythonhosted.org/packages/source/p/pyparsing/pyparsing-&pyparsing-version;.tar.gz">
<!ENTITY pyparsing-download-ftp " ">
<!ENTITY pyparsing-md5sum "&pyparsing-md5sum;">
<!ENTITY pyparsing-size "872 KB">
<!ENTITY pyparsing-buildsize "3.3 MB (add 27 MB for tests)">
<!ENTITY pyparsing-time "less than 0.1 SBU (0.3 SBU for tests)">
]>
<sect2 id="pyparsing" xreflabel="pyparsing-&pyparsing-version;">
<title>pyparsing-&pyparsing-version;</title>
<indexterm zone="pyparsing">
<primary sortas="a-pyparsing">pyparsing</primary>
</indexterm>
<sect3 role="package">
<title>Introduction to pyparsing Module</title>
<para>
The <application>pyparsing</application> module is an alternative
approach to creating and executing simple grammars, vs. the
traditional lex/yacc approach, or the use of regular expressions.
It provides a library of classes that client code uses to construct
the grammar directly in Python code.
</para>
&lfs121_checked;
<bridgehead renderas="sect4">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&pyparsing-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&pyparsing-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &pyparsing-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &pyparsing-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &pyparsing-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &pyparsing-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect4">pyparsing Dependencies</bridgehead>
<bridgehead renderas="sect5">Optional</bridgehead>
<para role="optional">
<ulink url="https://pypi.org/project/railroad-diagrams/">
railroad-diagrams
</ulink> (also needed for tests)
</para>
<bridgehead renderas="sect5">Optional (for testing)</bridgehead>
<para role="optional">
<xref linkend="pytest"/>
</para>
</sect3>
<sect3 role="installation">
<title>Installation of pyparsing</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; pyparsing</userinput></screen>
<para>
Assuming <xref linkend="pytest"/> is
installed, but the other optional dependency is not, the installation
can be tested with the following commands:
</para>
<screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &amp;&amp;
source testenv/bin/activate &amp;&amp;
pip3 install railroad-diagrams &amp;&amp;
python3 /usr/bin/pytest<!-- no && because of a possible error -->
deactivate</userinput></screen>
</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/pyparsing and
/usr/lib/python&python3-majorver;/site-packages/pyparsing-&pyparsing-version;.dist-info
</seg>
</seglistitem>
</segmentedlist>
</sect3>
</sect2>