source: general/prog/python-modules/pygobject3.xml@ f65e42d

<?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 pygobject3-download-http
           "&gnome-download-http;/pygobject/&gnome-minor-50;/pygobject-&pygobject3-version;.tar.xz">
  <!ENTITY pygobject3-download-ftp  " ">
  <!ENTITY pygobject3-md5sum        "8f34e4bc1d7d57faf558180b0051c9ef">
  <!ENTITY pygobject3-size          "912 KB">
  <!ENTITY pygobject3-buildsize     "10 MB (with tests)">
  <!ENTITY pygobject3-time          "0.2 SBU (with tests)">
]>

 <!-- Begin PyGObject3 -->
  <sect2 id="pygobject3" xreflabel="PyGObject-&pygobject3-version;">

    <title>PyGObject-&pygobject3-version;</title>

    <indexterm zone="pygobject3">
      <primary sortas="a-PyGObject3">PyGObject3</primary>
    </indexterm>

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

      <para>
        <application>PyGObject3</application> provides
        <application>Python</application> bindings to the GObject
        class from <application>GLib</application>.
      </para>

      &lfs122_checked;

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

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

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        &gobject-introspection;
      </para>

      <bridgehead renderas="sect5">Recommended</bridgehead>
      <para role="recommended">
        <xref linkend="pycairo"/>
      </para>

      <bridgehead renderas="sect5">Optional (for the tests)</bridgehead>
      <para role="optional">
        <xref linkend="gtk4"/>,
        <ulink url="https://pypi.python.org/pypi/pep8">pep8</ulink>,
        <ulink url="https://pypi.python.org/pypi/pyflakes">pyflakes</ulink>, and
        <xref linkend="pytest"/>
      </para>

    </sect3>

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

    <para>
      First, remove two faulty tests:
    </para>

<screen><userinput remap="pre">mv -v tests/test_gdbus.py{,.nouse}         &amp;&amp;
mv -v tests/test_overrides_gtk.py{,.nouse}</userinput></screen>

    <para>
      Install <application>pygobject3</application> 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 test the results, issue: <command>ninja test</command>.
      An already active graphical session with a bus address is necessary
      to run the tests. <!--One test, <filename>tests/test_gdbus.py</filename>,
      is known to fail.--> Another round of tests may report ERROR if
      <xref linkend="gtk4" role="nodep"/> is not installed.
    </para>

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

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

    </sect3>

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

      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
        href="../../../xincludes/meson-buildtype-release.xml"/>

      <para>
        <option>-D pycairo=disabled</option>: use this switch if you do not
        have <xref linkend="pycairo"/> installed.
      </para>
    </sect3>

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

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

        <seglistitem>
          <seg>
            None
           </seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/gi/_gi{,_cairo}.&python3-lib-suffix;.so
           </seg>
          <seg>
            /usr/include/pygobject-3.0 and
            /usr/lib/python&python3-majorver;/site-packages/{gi,pygtkcompat}
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>