source: general/prog/python-modules/pycairo.xml@ 14891a90

<?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 pycairo-download-http "https://github.com/pygobject/pycairo/releases/download/v&pycairo-version;/pycairo-&pycairo-version;.tar.gz">
  <!ENTITY pycairo-download-ftp  " ">
  <!ENTITY pycairo-md5sum        "9855a7b7a813d73b54a29f8b43529dea">
  <!ENTITY pycairo-size          "340 KB">
  <!ENTITY pycairo-buildsize     "3.0 MB">
  <!ENTITY pycairo-time          "less than 0.1 SBU">
]>

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

    <title>PyCairo-&pycairo-version;</title>

    <indexterm zone="pycairo">
      <primary sortas="a-PyCairo">PyCairo</primary>
    </indexterm>

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

      <para>
        PyCairo provides <application>Python</application> bindings to
        <application>Cairo</application>.
      </para>

      &lfs113_checked;
      <!-- Does not use gcc -->

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

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

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="cairo"/>
      </para>

      <bridgehead renderas="sect5">Optional</bridgehead>
      <para role="optional">
        <ulink url="https://hypothesis.readthedocs.io">Hypothesis</ulink> and
        <xref linkend="pytest"/> (for tests)
      </para>

    </sect3>

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

      <note>
        <para>
           The current version of pycairo no longer builds the Python2 module.
           If you need that module for packages such as <xref linkend="gimp"/>, use
           <xref linkend="pycairo2"/>
        </para>
      </note>

      <para>
        Install <application>PyCairo</application> for Python3 by
        running the following commands:
      </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</userinput></screen>

      <para>
        To run the tests, this package requires the optional pytest module. If
        it is installed, run the tests by running <command>ninja test</command>.
        <!--The <emphasis>test_surface.py</emphasis> test has a failure.-->
      </para>

      <para>
        Now, as the <systemitem class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>ninja install</userinput></screen>

    </sect3>

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

      <segmentedlist>
        <segtitle>Installed Program</segtitle>
        <segtitle>Installed Library</segtitle>
        <segtitle>Installed Directories</segtitle>

        <seglistitem>
          <seg>
            None
          </seg>
          <seg>
            None
          </seg>
          <seg>
            /usr/include/pycairo,
            /usr/lib/python&python3-majorver;/site-packages/cairo, and
            /usr/lib/python&python3-majorver;/site-packages/pycairo-&pycairo-version;.egg-info
          </seg>
        </seglistitem>
      </segmentedlist>
    </sect3>

  </sect2>