source: general/prog/python-modules/mako.xml@ 80f933b

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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 Mako-download-http "&pymodules-dl;/M/Mako/Mako-&mako-version;.tar.gz">
  <!ENTITY Mako-download-ftp  " ">
  <!ENTITY Mako-md5sum        "&mako-md5sum;">
  <!ENTITY Mako-size          "485 KB">
  <!ENTITY Mako-buildsize     "3.9 MB (add 1.2 MB for tests)">
  <!ENTITY Mako-time          "less than 0.1 SBU (with tests)">
]>

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

    <title>Mako-&mako-version;</title>

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

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

      <para>
        <application>Mako</application> is a <application>Python</application>
        module that implements hyperfast and lightweight templating for the
        <application>Python</application> platform.
      </para>

      &lfs113_checked;

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

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

      <bridgehead renderas="sect5" revision="sysv">Required</bridgehead>
      <para role="required" revision="sysv">
        <xref linkend="MarkupSafe"/>
      </para>

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

    </sect3>

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

      <para>
        Build the module:
      </para>

<screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>

      <para>
        Install the module as the &root; user:
      </para>

<screen role="root"><userinput>pip3 install --no-index --find-links dist --no-cache-dir --no-user Mako</userinput></screen>

    <para>
      To test the installation, 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>
            mako-render
          </seg>
          <seg>
            None
          </seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/mako and
            /usr/lib/python&python3-majorver;/site-packages/Mako-&mako-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

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

        <varlistentry id="mako-render">
          <term><command>mako-render</command></term>
          <listitem>
            <para>
             renders a template
            </para>
            <indexterm zone="Mako mako-render">
              <primary sortas="b-mako-render">mako-render</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>