source: general/prog/python3.xml@ 355495ce

<?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 python3-download-http
           "http://www.python.org/ftp/python/&python3-version;/Python-&python3-version;.tar.xz">
  <!ENTITY python3-download-ftp  " ">
  <!ENTITY python3-md5sum        "187564726f2c1473d301c586acc24847">
  <!ENTITY python3-size          "8.6 MB">
  <!ENTITY python3-buildsize     "200 MB (30 MB for the test suite)">
  <!ENTITY python3-time          "1.0 SBU (additional 3.0 SBU to run the test suite)">
  <!ENTITY python3htmldoc-download-http
           "http://docs.python.org/ftp/python/doc/&python3-version;/python-&python3-version;-docs-html.tar.bz2">
  <!ENTITY python3htmldoc-md5sum        "c970e7bcbc3268a3dbc2de5c15b5a3d3">
  <!ENTITY python3htmldoc-size          "4.2 MB">

]>

<sect1 id="python3" xreflabel="Python-&python3-version;">
  <?dbhtml filename="python3.html" ?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Python-&python3-version;</title>

  <indexterm zone="python3">
    <primary sortas="a-Python3">Python</primary>
  </indexterm>

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

    <para>
      The <application>Python</application> package contains the
      <application>Python</application> development environment.
      This is useful for object-oriented programming, writing scripts,
      prototyping large programs or developing entire applications.
    </para>

    &lfs71_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <title>Optional HTML Documentation</title>
      <listitem>
        <para>
          Download (HTTP): <ulink url="&python3htmldoc-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &python3htmldoc-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &python3htmldoc-size;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Python Dependencies</bridgehead>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="expat"/> and
      <xref linkend="libffi"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="bluez"/>
    </para>

    <bridgehead renderas="sect4">Optional (For Additional Modules)</bridgehead>
    <para role="optional">
      <xref linkend="db"/>
      <xref linkend="openssl"/>,
      <xref linkend="sqlite"/> and
      <xref linkend="tk"/>
    </para>

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

  <sect2 role="installation">
    <title>Installation of Python</title>

    <para>
      Install <application>Python</application> by running the following
      commands:
    </para>

<screen><userinput>sed -i "s/ndbm_libs = \[\]/ndbm_libs = ['gdbm', 'gdbm_compat']/" setup.py &amp;&amp;
./configure --prefix=/usr \
            --enable-shared \
            --with-wide-unicode \
            --with-system-expat \
            --with-system-ffi &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make test</command>. Note that
      if you have an existing <application>Python</application> installation
      which includes the <application>PyXML</application> module, the tests could
      produce a segmentation fault.
    </para>

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

<screen role="root"><userinput>make install                                              &amp;&amp;
chmod -v 755 /usr/lib/libpython&python3-majorver;mu.so &amp;&amp;
chmod -v 755 /usr/lib/libpython3.so</userinput></screen>

    <para>
      There is no documentation installed using the instructions above.
      See the <filename>Doc/README.txt</filename> file in the source
      distribution for instructions on how to create the html. Alternatively,
      you can download preformatted documentation from
      <ulink url="http://docs.python.org/download.html"/>.
   </para>

    <para>
      In order to use the <command>help ('name_string')</command> feature
      of the <command>python</command> interpreter with some statements and
      keywords, you must download (or create) the optional HTML documentation
      and install it. If you downloaded the HTML docs, issue the following
      commands as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/Python-&python3-version;/html &amp;&amp;
tar --strip-components=1 \
    --no-same-owner \
    --no-same-permissions \
    -C /usr/share/doc/Python-&python3-version;/html \
    -xvf ../python-&python3-version;-docs-html.tar.bz2</userinput></screen>

  </sect2>

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

    <para>
      <command>sed -i "s/ndbm_libs = ..." setup.py</command>: This command
      is used to fix a build problem with the <application>GDBM</application>
      library.
    </para>

    <para>
      <option>--with-sytem-expat</option>: This switch enables linking against
      system version of <application>Expat</application>. Remove if you have
      not installed recommended dependency <xref linkend="expat"/>.
    </para>

    <para>
      <option>--with-system-ffi</option>: This switch enables linking against
      system version of <application>libffi</application>. Remove if you have
      not installed recommended dependency <xref linkend="libffi"/>.
    </para>

    <para>
      <command>chmod ...</command>: Fix permissions for shared libraries to be 
      consistent with other libraries.
    </para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Python</title>

    <para>
      In order for <command>python</command> to find the installed
      documentation, you must add the following environment variable to
      individual user's or the system's profile:
    </para>

<screen role="root"><userinput>export PYTHONDOCS=/usr/share/doc/Python-&python3-version;/html</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>
          2to3 (symbolic link to 2to3-&python3-majorver;),
          2to3-&python3-majorver;,

          pydoc3 (symbolic link to pydoc&python3-majorver;),
          pydoc&python3-majorver;,

          python3 (hard link to python&python3-majorver;mu), 
          python&python3-majorver; (hard link to python&python3-majorver;mu), 
          python&python3-majorver;mu, 

          python3-config (symbolic link to python&python3-majorver;-config),
          python&python3-majorver;-config (symbolic link to python3-config),
          python&python3-majorver;mu-config,

          and optionally if Tk is installed,
          idle3 (symbolic link to idle&python3-majorver;),
          idle&python3-majorver;
        </seg>
        <seg>
          libpython&python3-majorver;mu.so, libpython3.so and numerous
          modules installed in /usr/lib/python&python3-majorver;
        </seg>
        <seg>
          /usr/include/python&python3-majorver;mu,
          /usr/lib/python&python3-majorver;, and
          /usr/share/doc/python-&python3-version;
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="idle3">
        <term><command>idle3</command></term>
        <listitem>
          <para>
            is a wrapper script that opens a
            <application>Python</application> aware GUI editor.
          </para>
          <indexterm zone="python3 idle3">
            <primary sortas="b-idle3">idle3</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pydoc3">
        <term><command>pydoc3</command></term>
        <listitem>
          <para>
            is the <application>Python</application> documentation
            tool.
          </para>
          <indexterm zone="python3 pydoc3">
            <primary sortas="b-pydoc3">pydo3c</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="python3-prog">
        <term><command>python3</command></term>
        <listitem>
          <para>
            is an interpreted, interactive, object-oriented programming
            language.
          </para>
          <indexterm zone="python3 python3-prog">
            <primary sortas="b-python3">python3</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="python-ver">
        <term><command>python&python3-majorver;</command></term>
        <listitem>
          <para>
            is a version-specific name for the <command>python</command>
            program.
          </para>
          <indexterm zone="python3 python-ver">
            <primary
            sortas="b-python&python3-majorver;">python&python3-majorver;</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>