source: general/prog/decorator.xml@ 1b9f28f

<?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 decorator-download-http "https://files.pythonhosted.org/packages/source/d/decorator/decorator-&decorator-version;.tar.gz">
  <!ENTITY decorator-download-ftp  " ">
  <!ENTITY decorator-md5sum        "d83c624cce93e6bdfab144821b526e1d">
  <!ENTITY decorator-size          "36 KB">
  <!ENTITY decorator-buildsize     "244 KB">
  <!ENTITY decorator-time          "less than 0.1 SBU">
]>

  <!-- Begin decorator -->
  <sect2 id="decorator" xreflabel="decorator-&decorator-version;">
    <title>decorator-&decorator-version;</title>

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

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

      <para>
        The goal of the <application>decorator</application> module is to make
        it easy to define signature-preserving function decorators and
        decorator factories.
      </para>

      &lfs91_checked;

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

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

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

      <para>Install decorator with the following commands:</para>

<screen><userinput>python3 setup.py build</userinput></screen>

      <para>
        This package does not come with a test suite.
      </para>

      <para>
        To install the decorator package with the following command as the
        <systemitem class="username">root</systemitem> user:
      </para>

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

    </sect3>

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

      <segmentedlist>
        <segtitle>Installed Programs</segtitle>
        <segtitle>Installed Libraries</segtitle>
        <segtitle>Installed Directories</segtitle>

        <seglistitem>
          <seg>
            None
          </seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/decorator/decorator-&decorator-version;-py&python3-majorver;.egg-info
          </seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/decorator
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>
  <!-- End decorator -->