source: general/prog/python-dependencies/commonmark.xml@ 569925c7

<?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 commonmark-download-http "https://files.pythonhosted.org/packages/source/c/commonmark/commonmark-&commonmark-version;.tar.gz">
  <!ENTITY commonmark-download-ftp  " ">
  <!ENTITY commonmark-md5sum        "&commonmark-md5sum;">
  <!ENTITY commonmark-size          "94 KB">
  <!ENTITY commonmark-buildsize     "1.3 MB (add 30 MB for tests)">
  <!ENTITY commonmark-time          "less than 0.1 SBU (0.1 SBU for tests)">
]>

  <sect2 id="commonmark" xreflabel="commonmark-&commonmark-version;">

    <title>Commonmark-&commonmark-version;</title>

    <indexterm zone="commonmark">
      <primary sortas="a-commonmark">commonmark</primary>
    </indexterm>

    <sect3 role="package">
      <title>Introduction to Commonmark Module</title>

      <para>
        <application>Commonmark</application> Python parser for the CommonMark
        Markdown specification.
      </para>

      &lfs112_checked;

      <bridgehead renderas="sect4">Package Information</bridgehead>
      <itemizedlist spacing="compact">
        <listitem>
          <para>
            Download (HTTP): <ulink url="&commonmark-download-http;"/>
          </para>
        </listitem>
        <listitem>
          <para>
            Download (FTP): <ulink url="&commonmark-download-ftp;"/>
          </para>
        </listitem>
        <listitem>
          <para>
            Download MD5 sum: &commonmark-md5sum;
          </para>
        </listitem>
        <listitem>
          <para>
            Download size: &commonmark-size;
          </para>
        </listitem>
        <listitem>
          <para>
            Estimated disk space required: &commonmark-buildsize;
          </para>
        </listitem>
        <listitem>
          <para>
            Estimated build time: &commonmark-time;
          </para>
        </listitem>
      </itemizedlist>

      <bridgehead renderas="sect4">Commonmark Dependencies</bridgehead>

      <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
      <para role="optional">
        <xref linkend="pytest"/>,
        <ulink url="https://pypi.org/project/flake8/">flake8</ulink>, and
        <ulink url="https://pypi.org/project/hypothesis/">hypothesis</ulink>
      </para>


    </sect3>

    <sect3 role="installation">
      <title>Installation of Commonmark</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 commonmark</userinput></screen>

    <para>
      Assuming <xref linkend="pytest"/> is installed and the other optional
      dependency is not, the installation can be tested with:
    </para>

<screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &amp;&amp;
source testenv/bin/activate                    &amp;&amp;
pip3 install hypothesis                        &amp;&amp;
python3 /usr/bin/pytest commonmark/tests/unit_tests.py<!-- no && because of a possible error -->
python3 commonmark/tests/run_spec_tests.py
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>cmark</seg>
          <seg>None</seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/commonmark and
            /usr/lib/python&python3-majorver;/site-packages/commonmark-&commonmark-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

      <variablelist>
        <bridgehead renderas="sect3">Short Descriptions</bridgehead>
        <?dbfo list-presentation="list"?>
        <?dbhtml list-presentation="table"?>

        <varlistentry id="cmark">
          <term><command>cmark</command></term>
          <listitem>
            <para>
              processes Markdown according to the CommonMark specification
            </para>
            <indexterm zone="commonmark cmark">
              <primary sortas="b-cmark">cmark</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>