glfs/general/prog/python-modules.xml

<?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;
]>

<sect1 id="python-modules" xreflabel="Python Modules">
  <?dbhtml filename="python-modules.html" ?>


  <title>Python Modules</title>

  <indexterm zone="python-modules">
    <primary sortas="a-Python-Modules">Python Modules</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Python Modules</title>

    <para>
      The <application>Python</application> module packages add useful objects
      to the <application>Python</application> language. Modules utilized by
      packages throughout BLFS are listed here, along with their dependencies.
    </para>

    <important>
      <para>
        In BLFS, we normally build and install Python 3 modules with
        <command>pip3</command>.  Please take care that the
        <command>pip3 install</command> commands in the book should be
        run as &root; unless it's for a Python virtual environment.  Running
        <command>pip3 install</command> as a non-&root; user may seem to
        work fine, but it will cause the installed module to be inaccessible by
        other users.
      </para>
      <para>
        <command>pip3 install</command> will not reinstall an already
        installed module by default.  For using the
        <command>pip3 install</command> command to upgrade a module (for
        example, from meson-0.61.3 to meson-0.62.0), insert
        <parameter>--upgrade</parameter> into the command line.  If it's really
        necessary to downgrade a module or reinstall the same version for
        some reason, insert <parameter>--force-reinstall</parameter> into
        the command line.
      </para>
    </important>

    <itemizedlist spacing="compact">
<!--
      <listitem>
        <para>
          <xref linkend="pythonhosted"/>
        </para>
      </listitem>
-->
      <listitem>
        <para>
          <xref linkend="asciidoc"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="cython"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="dbus-python"/>
        </para>
      </listitem>
<!--      <listitem>
        <para>
          <xref linkend="decorator"/>
        </para>
      </listitem>
-->
      <listitem>
        <para>
          <xref linkend="docutils"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="doxypypy"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="doxyqml"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="gi-docgen"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="packaging"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="py3c"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="pyatspi2"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="pycairo"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="pycairo2"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="pycryptodome"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="python-dbusmock"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="pygments"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="pygobject2"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="pygobject3"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="pygtk"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="pyxdg"/>
        </para>
      </listitem>
<!--      <listitem>
        <para>
          <xref linkend="funcsigs"/>
        </para>
      </listitem>
-->
<!--      <listitem>
        <para>
          <xref linkend="Beaker"/>
        </para>
      </listitem>
-->
      <listitem>
        <para>
          <xref linkend="libxml2py2"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="lxml"/>
        </para>
      </listitem>
      <listitem revision="sysv">
        <para>
          <xref linkend="MarkupSafe"/>
        </para>
      </listitem>
      <listitem revision="sysv">
        <para>
          <xref linkend="Jinja2"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="Mako"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="pyparsing"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="pytest"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="recommonmark"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="requests"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="scour"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="six"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="sphinx"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="sphinx_rtd_theme"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="PyYAML"/>
        </para>
      </listitem>
    </itemizedlist>
  </sect2>

<!--
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-dependencies/pythonhosted.xml"/>
-->
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/asciidoc.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/cython.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/dbus-python.xml"/>

<!--  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="decorator.xml"/>
-->
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/docutils.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/doxypypy.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/doxyqml.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/gi-docgen.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/packaging.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/py3c.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/pyatspi2.xml"/>
<!--
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="py2cairo.xml"/>
-->
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/pycairo.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/pycairo2.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/pycryptodome.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/python-dbusmock.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/pygments.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/pygobject2.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/pygobject3.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/pygtk.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/pyxdg.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/recommonmark.xml"/>

<!--
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="setuptools.xml"/>
-->

<!--  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="funcsigs.xml"/> -->

<!--  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="beaker.xml"/>-->

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/libxml2py2.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/lxml.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/markupsafe.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/jinja2.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/mako.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/pyparsing.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/pytest.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/pyyaml.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/requests.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/scour.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/six.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/sphinx.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="python-modules/sphinx_rtd_theme.xml"/>

</sect1>