source: general/prog/dbus-python.xml@ 484f776

<?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 dbus-python-download-http "https://dbus.freedesktop.org/releases/dbus-python/dbus-python-&dbus-python-version;.tar.gz">
  <!ENTITY dbus-python-download-ftp  " ">
  <!ENTITY dbus-python-md5sum        "33be8a4a766e1c7c9a377b8f934ce21a">
  <!ENTITY dbus-python-size          "592 KB">
  <!ENTITY dbus-python-buildsize     "4.7 MB (with tests)" >
  <!ENTITY dbus-python-time          "less than 0.1 SBU (with tests)">
  <!ENTITY dbus-python-egg-info      "&python3-site;/dbus_python-&dbus-python-version;.egg-info">
]>

  <!-- Begin D-Bus Python -->
  <sect2 id="dbus-python" xreflabel="D-Bus Python-&dbus-python-version;">
    <title>D-Bus Python-&dbus-python-version;</title>

    <indexterm zone="dbus-python">
      <primary sortas="a-dbus-python">dbus-python</primary>
    </indexterm>

    <sect3 role="package">
      <title>Introduction to D-Bus Python Module</title>

      <para>
        <application>D-Bus Python</application> provides
        <application>Python</application> bindings to the
        <application>D-Bus</application> API interface.
      </para>

      &lfs112_checked;

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

      <bridgehead renderas="sect4">D-Bus Python Dependencies</bridgehead>

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="dbus"/> and
        <xref linkend="glib2"/>
      </para>

      <bridgehead renderas="sect5">Optional</bridgehead>
      <para role="optional">
        <xref linkend="pygobject3"/> and
        <ulink url="https://pypi.python.org/pypi/tap.py/">tap.py</ulink>
        (required for some tests)
      </para>

      <bridgehead renderas="sect5">
       Optional (Required to build the API and HTML Documentation)</bridgehead>
      <para role="optional">
        <xref linkend="docutils"/> and
        <ulink url="https://www.sphinx-doc.org/en/master/">Sphinx</ulink> with
        <ulink url="https://github.com/rtfd/sphinx_rtd_theme">sphinx_rtd_theme</ulink>
      </para>

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

    <sect3 role="installation">
      <title>Installation of D-Bus Python</title>

      <para>
        Build the D-Bus Python module by running the following  commands:
      </para>

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

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

      <para>
        To test the results, issue: <command>ninja test</command>.
      </para>

      <para>
        Now install the module as the &root; user:
      </para>

<screen role="root"><userinput>ninja install &amp;&amp;
cp -rv ../dbus_python.egg-info \
   -T  &dbus-python-egg-info;</userinput></screen>

    </sect3>

    <sect3 role="commands">

      <title>Command Explanations</title>

      <para>
        <command>cp -rv ... -T ...</command>: Install the metadata of this
        Python module so <command>pip3</command> will be able to find this
        module and use it as a dependency building and installing other
        modules.  <parameter>-T</parameter> is used to make this command
        behave properly in case that this module is reinstalled.
      </para>

    </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>
            None
          </seg>
          <seg>
            &python3-site;/dbus and &dbus-python-egg-info;
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>