source: general/prog/python-modules/pyserial.xml@ 7064886

<?xml version="1.0" encoding="UTF-8"?>
<!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 pyserial-download-http "https://files.pythonhosted.org/packages/source/p/pyserial/pyserial-&pyserial-version;.tar.gz">
  <!ENTITY pyserial-download-ftp  " ">
  <!ENTITY pyserial-md5sum        "&pyserial-md5sum;">
  <!ENTITY pyserial-size          "156 KB">
  <!ENTITY pyserial-buildsize     "2.1 MB (add 0.2 MB for tests)">
  <!ENTITY pyserial-time          "less than 0.1 SBU">
]>

  <!-- capitalization as in https://pythonhosted.org/pyserial/ -->
  <sect2 id="pyserial" xreflabel="pySerial-&pyserial-version;">

    <title>pySerial-&pyserial-version;</title>

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

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

      <para>
        The <application>pySerial</application> module encapsulates
        access to the serial port.
      </para>

      &lfs120_checked;

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

      <bridgehead renderas="sect4">pySerial Dependencies</bridgehead>

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="setuptools_scm"/>
      </para>

      <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
      <para role="optional">
        <xref linkend="pluggy"/> and
        <xref linkend="pytest"/>
      </para>

    </sect3>

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

      <para> Build the module: </para>

&build-wheel;

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

<screen role="root"><userinput>&install-wheel; pyserial</userinput></screen>

      <para>
        To test the installation issue <command>pytest</command>.
      </para>

    </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>
            pyserial-miniterm and pyserial-ports
          </seg>
          <seg>None</seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/pyserial-&pyserial-version;.dist-info and
            /usr/lib/python&python3-majorver;/site-packages/serial
          </seg>
        </seglistitem>
      </segmentedlist>

      <variablelist>
        <bridgehead renderas="sect5">Short Descriptions</bridgehead>
        <?dbfo list-presentation="list"?>
        <?dbhtml list-presentation="table"?>
        <varlistentry id="pyserial-miniterm">
          <term><command>pyserial-miniterm</command></term>
          <listitem>
            <para>
              is a console application that provides a small terminal application.
              It may inherit terminal features from the terminal in which it is
              run.
            </para>
            <indexterm zone="pyserial pyserial-miniterm">
              <primary sortas="b-pyserial-miniterm">pyserial-miniterm</primary>
            </indexterm>
          </listitem>
        </varlistentry>
        <varlistentry id="pyserial-ports">
          <term><command>pyserial-ports</command></term>
          <listitem>
            <para>
              lists available ports.
            </para>
            <indexterm zone="pyserial pyserial-ports">
              <primary sortas="b-pyserial-ports">pyserial-ports</primary>
            </indexterm>
          </listitem>
        </varlistentry>
      </variablelist>

    </sect3>

  </sect2>