source: general/prog/python-modules/psutil.xml@ 88bdca3

<?xml version="1.0" encoding="UTF-8"?>
<!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 psutil-download-http "&pymodules-dl;/p/psutil/psutil-&psutil-version;.tar.gz">
  <!ENTITY psutil-download-ftp  " ">
  <!ENTITY psutil-md5sum        "&psutil-md5sum;">
  <!ENTITY psutil-size          "500 KB">
  <!ENTITY psutil-buildsize     "4.3 MB">
  <!ENTITY psutil-time          "less than 0.1 SBU">
]>

  <!-- Begin psutil -->
  <sect2 id="psutil" xreflabel="psutil-&psutil-version;">

    <title>psutil-&psutil-version;</title>

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

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

      <para>
        psutil (process and system utilities) is a cross-platform library 
        for retrieving information on running processes and system utilization 
        (CPU, memory, disks, network, sensors) in Python. It is useful mainly 
        for system monitoring, profiling and limiting process resources and 
        management of running processes. It implements many functionalities offered 
        by classic UNIX command line tools such as ps, top, iotop, lsof, netstat, 
        ifconfig, free and others.
      </para>

      &lfs122_checked;

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

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

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

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

      <para>
        Build the module:
      </para>

&build-wheel;

      <para>
        Now, as the &root; user:
      </para>

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

      <para>
        To test the results, issue: <command>make test</command>.
      </para>

      <para>
        Two tests, <literal>TestSystemAPIs::test_disk_usage</literal> and
        <literal>TestNetAPIs::test_net_if_addrs</literal>, are known to fail.
        And, one test named
        <literal>TestAvailProcessAPIs::test_io_counters</literal>
        is known to fail if the kernel does not have
        <option>CONFIG_TASK_IO_ACCOUNTING</option> enabled.
      </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>
            None
          </seg>
          <seg>
            None
          </seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/psutil-&psutil-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>
    </sect3>

  </sect2>