source: general/prog/python-modules/pyyaml.xml@ aeb0a9c

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 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 PyYAML-download-http "https://files.pythonhosted.org/packages/source/P/PyYAML/pyyaml-&PyYAML-version;.tar.gz">
  <!ENTITY PyYAML-download-ftp  " ">
  <!ENTITY PyYAML-md5sum        "&PyYAML-md5sum;">
  <!ENTITY PyYAML-size          "128 KB">
  <!ENTITY PyYAML-buildsize     "8.5 MB">
  <!ENTITY PyYAML-time          "0.1 SBU">
]>

  <!-- Begin PyYAML -->
  <sect2 id="PyYAML" xreflabel="PyYAML-&PyYAML-version;">

    <title>PyYAML-&PyYAML-version;</title>

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

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

      <para>
        <application>PyYAML</application> is a <application>Python</application>
        module that implements the next generation YAML parser and emitter.
      </para>

      &lfs122_checked;

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

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

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="cython"/> and
        <xref linkend="libyaml"/>
      </para>

      <bridgehead renderas="sect5">Optional</bridgehead>
      <para role="optional">
        <xref linkend="pytest"/> (for testing)
      </para>

    </sect3>

    <sect3 role="installation">
      <title>Installation of PyYAML</title>

      <para>
        Build PyYAML with the following command:
      </para>

&build-wheel;

      <para>
        Now, install the module as the &root; user:
      </para>

<screen role="root"><userinput>&install-wheel; PyYAML</userinput></screen>

      <para>
        To test the results, issue: <command>pytest</command>.
      </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/PyYAML-&yaml-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>