source: general/prog/python-modules/cython.xml@ 569925c7

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect2 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 cython-download-http "https://github.com/cython/cython/releases/download/&cython-version;/Cython-&cython-version;.tar.gz">
  <!ENTITY cython-download-ftp  " ">
  <!ENTITY cython-md5sum        "&cython-md5sum;">
  <!ENTITY cython-size          "2.0 MB">
  <!ENTITY cython-buildsize     "66 MB">
  <!ENTITY cython-time          "0.5 SBU">
]>

  <sect2 id="cython" xreflabel="cython-&cython-version;">

    <title>Cython-&cython-version;</title>

    <indexterm zone="cython">
      <primary sortas="a-cython">cython</primary>
    </indexterm>

    <sect3 role="package">
      <title>Introduction to Cython Module</title>

      <para>
        The <application>Cython</application> package provides a
         compiler for writing C extensions for the Python language.
      </para>

      &lfs112_checked;

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

    </sect3>

    <sect3 role="installation">
      <title>Installation of Cython</title>

      <para>
        Build the module:
      </para>

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

      <para>
        This package does not come with a test suite.
      </para>

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

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

    </sect3>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../../xincludes/pip3-cmd-explain.xml"/>

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

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

        <seglistitem>
          <seg>cygdb cython cythonize</seg>
          <seg>None</seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/Cython,
            /usr/lib/python&python3-majorver;/site-packages/Cython-&cython-version;.dist-info, and
            /usr/lib/python&python3-majorver;/site-packages/pyximport
          </seg>
        </seglistitem>
      </segmentedlist>

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

        <varlistentry id="cygdb">
          <term><command>cygdb</command></term>
          <listitem>
            <para>
              is the Cython debugger
            </para>
            <indexterm zone="cython cygdb">
              <primary sortas="b-cygdb">cygdb</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="cython-prog">
          <term><command>cython</command></term>
          <listitem>
            <para>
              is a compiler for code written in the Cython language. It outputs
              a C/C++ program which can be compiled with a C/C++ compiler
            </para>
            <indexterm zone="cython cython-prog">
              <primary sortas="b-cython-prog">cython</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="cythonize">
          <term><command>cythonize</command></term>
          <listitem>
            <para>
              is a compiler for code written in the Cython language. It outputs
              an extension module which is directly importable from Python
            </para>
            <indexterm zone="cython cythonize">
              <primary sortas="b-cythonize">cythonize</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>