source: general/prog/pygobject3.xml@ 427b46a

<?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 pygobject3-download-http
           "&gnome-download-http;/pygobject/&gnome-minor-38;/pygobject-&pygobject3-version;.tar.xz">
  <!ENTITY pygobject3-download-ftp
           "&gnome-download-ftp;/pygobject/&gnome-minor-38;/pygobject-&pygobject3-version;.tar.xz">
  <!ENTITY pygobject3-md5sum        "2ad8d8f10d1f12a8c66d8179659d5eb9">
  <!ENTITY pygobject3-size          "544 KB">
  <!ENTITY pygobject3-buildsize     "15 MB">
  <!ENTITY pygobject3-time          "0.1 SBU (Using parallelism=4)">
]>

 <!-- 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>

      &lfs101_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">
        <xref linkend="gobject-introspection"/> and
        <xref linkend="pycairo"/>
          (<application>Python 3</application> module)
      </para>

      <bridgehead renderas="sect5">Optional (for the tests)</bridgehead>
      <para role="optional">
        <ulink url="https://pypi.python.org/pypi/pep8">pep8</ulink>,
        <ulink url="https://pypi.python.org/pypi/pyflakes">pyflakes</ulink>, and
        <ulink url="https://pypi.python.org/pypi/pytest">pytest</ulink>
        <!-- pytest brings in a lot of dependencies - upwards of 10 -->
      </para>

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

    <sect3 role="installation">
      <title>Installation of PyGObject3</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 build <application>PyGObject3</application> as a
        <application>Python 2</application> module, run the
        following commands:
      </para>

<screen><userinput>mkdir python2                             &amp;&amp;
pushd python2                             &amp;&amp;
  meson - -prefix=/usr -Dpython=python2 .. &amp;&amp;
  ninja                                   &amp;&amp;
popd</userinput></screen>

      <para>
        To test the results, issue: <command>ninja -C python2 test</command>.
        An already active graphical session with bus address is necessary to
        run the tests. Two tests fail due to a search for GTK+-4, which has not
        been released yet.
      </para>

      <para>
        To build <application>PyGObject3</application> as a
        <application>Python 3</application> module, run the
        following commands:
      </para>

<screen><userinput>mkdir python3                             &amp;&amp;
pushd python3                             &amp;&amp;
  meson - -prefix=/usr -Dpython=python3 .. &amp;&amp;
  ninja                                   &amp;&amp;
popd</userinput></screen>

      <para>
        To test the results, issue: <command>ninja -C python3 test</command>.
        An already active graphical session with bus address is necessary to
        run the tests. Two tests fail due to a search for GTK+-4, which has not
        been released yet.
      </para>

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

<screen role="root"><userinput>ninja -C python2 install</userinput></screen>

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

<screen role="root"><userinput>ninja -C python3 install</userinput></screen>
-->
    <para>
      Install <application>pygobject3</application> by running the following
      commands:
    </para>

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

meson --prefix=/usr .. &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.
    </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 Programs</segtitle>
        <segtitle>Installed Library</segtitle>
        <segtitle>Installed Directories</segtitle>

        <seglistitem>
          <seg>
            None
           </seg>
          <seg>
            <!--/usr/lib/python&python2-majorver;/site-packages/gi/_gi{,_cairo}.so and/or-->
            /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&python2-majorver;/site-packages/{gi,pygtkcompat} and/or-->
            /usr/lib/python&python3-majorver;/site-packages/{gi,pygtkcompat}
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>