source: general/prog/dbus-python.xml@ 97a1efc

<?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        "468874f3bf61d1b7deac98bbe2cfd8ac">
  <!ENTITY dbus-python-size          "568 KB">
  <!ENTITY dbus-python-buildsize     "7.8 MB" >
  <!ENTITY dbus-python-time          "0.1 SBU">
]>

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

      &lfs111_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">Recommended</bridgehead>
      <para role="recommended">
        <xref linkend="python2"/> (some applications in the book require
        the Python 2 module)
      </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="http://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>
<!--
      <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>D-Bus Python</application> as the
        <application>Python 2</application> module, run the
        following commands:
      </para>

<screen><userinput>mkdir python2 &amp;&amp;
pushd python2 &amp;&amp;
PYTHON=/usr/bin/python2     \
../configure - -prefix=/usr - -disable-documentation &amp;&amp;
make &amp;&amp;
popd</userinput></screen>

      <para>
        To test the results, issue: <command>make -C python2 check</command>.
        Several tests report an error due to dbus issues.
      </para>

      <para>
        To build <application>D-Bus Python</application> as the
        <application>Python 3</application> module, run the
        following commands:
      </para>
-->
      <para>
        To build the <application>Python 3 D-Bus Python</application> 
        module, run the following command:
      </para>

<screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>

<!--
      <para>
        To test the results, issue: <command>make -C python3 check</command>.
      </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>make -C python2 install</userinput></screen>
-->
      <para>
        To install the module, run the following command as the &root; user:
      </para>

<screen role="root"><userinput>pip3 install --no-index --find-links dist --no-cache-dir dbus-python</userinput></screen>

    </sect3>

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

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

        <seglistitem>
          <seg>
            None
          </seg>
          <seg>
            None
          </seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/dbus
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>