source: archive/mako.xml@ 90cb5d6

<?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
           "https://pypi.python.org/packages/source/M/Mako/Mako-&mako-version;.tar.gz">
  <!ENTITY mako-download-ftp  " ">
  <!ENTITY mako-md5sum        "9f0aafd177b039ef67b90ea350497a54">
  <!ENTITY mako-size          "462 KB">
  <!ENTITY mako-buildsize     "4.9 MB">
  <!ENTITY mako-time          "less than 0.1 SBU">
]>

  <!-- 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>
        Mako is a template library written in <application>Python
        </application>. It provides a familiar, non-XML syntax which compiles
        into Python modules for maximum performance.
      </para>

      &lfs77_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">Required</bridgehead>
      <para role="required">
        <xref linkend="setuptools"/> and
        <xref linkend="python2"/> or <xref linkend="python3"/>
      </para>

      <bridgehead renderas="sect5">Optional</bridgehead>
      <para role="optional">
        <ulink url="http://www.voidspace.org.uk/python/mock">mock</ulink>
      </para>

      <para condition="html" role="usernotes">
        User Notes: <ulink url="&blfs-wiki;/mako"/>
      </para>
    </sect3>

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

      <note>
        <para>
          Both <application>Python 2</application> and
          <application>Python 3</application> modules can
          be built and installed without any conflicts.
        </para>
      </note>

      <para>
        To install <application>Mako</application> for <application>Python
        2</application>, run the following command as the <systemitem
        class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>python setup.py install --optimize=1</userinput></screen>

      <para>
        To install <application>Mako</application> for <application>Python
        3</application>, run the following command as the <systemitem
        class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>sed -i "s:mako-render:&amp;3:g" setup.py &amp;&amp;
python3 setup.py install --optimize=1</userinput></screen>

      <para>
        The test suite requires the optional <application>mock</application>
        python module. If it is not installed and you have internet access, it
        will be automatically downloaded before the tests. Run the tests by
        issuing <command>python setup.py test</command> and/or <command>python3
        setup.py test</command>.
      </para>


    </sect3>

    <sect3 role="commands">
      <title>Command Explanations</title>

      <para>
        <command>sed -i "s:mako-render:&amp;3:g" setup.py</command>: This sed
        prevents <command>setup.py</command> from overwriting an already
        installed script by the <application>Python 2</application> module.
        Remove it if you are building this module only for
        <application>Python 3</application>.
      </para>

    </sect3>

    <sect3 role="content">
      <title>Contents</title>

      <segmentedlist>
        <segtitle>Installed Programs</segtitle>
        <segtitle>Installed Library</segtitle>
        <segtitle>Installed Directory</segtitle>

        <seglistitem>
          <seg>
            None
          </seg>
          <seg>
            None
          </seg>
          <seg>
            /usr/lib/python&python2-majorver;/site-packages/Mako-&mako-version;-py&python2-majorver;.egg and/or
            /usr/lib/python&python3-majorver;/site-packages/Mako-&mako-version;-py&python3-majorver;.egg
          </seg>
        </seglistitem>
      </segmentedlist>
    </sect3>
  </sect2>
  <!-- End Mako -->