[2563594f] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY psutil-download-http "&pymodules-dl;/p/psutil/psutil-&psutil-version;.tar.gz">
|
---|
| 8 | <!ENTITY psutil-download-ftp " ">
|
---|
| 9 | <!ENTITY psutil-md5sum "&psutil-md5sum;">
|
---|
[2ecff2c5] | 10 | <!ENTITY psutil-size "500 KB">
|
---|
[2563594f] | 11 | <!ENTITY psutil-buildsize "4.3 MB">
|
---|
| 12 | <!ENTITY psutil-time "less than 0.1 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <!-- Begin psutil -->
|
---|
| 16 | <sect2 id="psutil" xreflabel="psutil-&psutil-version;">
|
---|
| 17 |
|
---|
| 18 | <title>psutil-&psutil-version;</title>
|
---|
| 19 |
|
---|
| 20 | <indexterm zone="psutil">
|
---|
| 21 | <primary sortas="a-psutil">psutil</primary>
|
---|
| 22 | </indexterm>
|
---|
| 23 |
|
---|
| 24 | <sect3 role="package">
|
---|
| 25 | <title>Introduction to psutil Module</title>
|
---|
| 26 |
|
---|
| 27 | <para>
|
---|
| 28 | psutil (process and system utilities) is a cross-platform library
|
---|
| 29 | for retrieving information on running processes and system utilization
|
---|
| 30 | (CPU, memory, disks, network, sensors) in Python. It is useful mainly
|
---|
| 31 | for system monitoring, profiling and limiting process resources and
|
---|
| 32 | management of running processes. It implements many functionalities offered
|
---|
| 33 | by classic UNIX command line tools such as ps, top, iotop, lsof, netstat,
|
---|
| 34 | ifconfig, free and others.
|
---|
| 35 | </para>
|
---|
| 36 |
|
---|
[09ddf35a] | 37 | &lfs122_checked;
|
---|
[2563594f] | 38 |
|
---|
| 39 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&psutil-download-http;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&psutil-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download MD5 sum: &psutil-md5sum;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download size: &psutil-size;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated disk space required: &psutil-buildsize;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated build time: &psutil-time;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
[88bdca3] | 73 | <bridgehead renderas="sect4">Packaging Dependencies</bridgehead>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
| 76 | <para role="optional">
|
---|
| 77 | <xref linkend="pytest"/>
|
---|
| 78 | </para>
|
---|
[2563594f] | 79 | </sect3>
|
---|
| 80 |
|
---|
| 81 | <sect3 role="installation">
|
---|
| 82 | <title>Installation of psutil</title>
|
---|
| 83 |
|
---|
| 84 | <para>
|
---|
| 85 | Build the module:
|
---|
| 86 | </para>
|
---|
| 87 |
|
---|
| 88 | &build-wheel;
|
---|
| 89 |
|
---|
[258caf3] | 90 | <para>
|
---|
| 91 | Now, as the &root; user:
|
---|
| 92 | </para>
|
---|
| 93 |
|
---|
| 94 | <screen role="root"><userinput>&install-wheel; psutil</userinput></screen>
|
---|
| 95 |
|
---|
[2563594f] | 96 | <para>
|
---|
[3986161] | 97 | To test the results, issue: <command>make test</command>.
|
---|
[a14a1ff3] | 98 | </para>
|
---|
| 99 |
|
---|
[ced692d8] | 100 | <para>
|
---|
[3986161] | 101 | Two tests, <literal>TestSystemAPIs::test_disk_usage</literal> and
|
---|
| 102 | <literal>TestNetAPIs::test_net_if_addrs</literal>, are known to fail.
|
---|
[88bdca3] | 103 | And, one test named
|
---|
| 104 | <literal>TestAvailProcessAPIs::test_io_counters</literal>
|
---|
| 105 | is known to fail if the kernel does not have
|
---|
| 106 | <option>CONFIG_TASK_IO_ACCOUNTING</option> enabled.
|
---|
[2563594f] | 107 | </para>
|
---|
| 108 |
|
---|
| 109 | </sect3>
|
---|
| 110 |
|
---|
| 111 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 112 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 113 |
|
---|
| 114 | <sect3 role="content">
|
---|
| 115 | <title>Contents</title>
|
---|
| 116 |
|
---|
| 117 | <segmentedlist>
|
---|
| 118 | <segtitle>Installed Programs</segtitle>
|
---|
| 119 | <segtitle>Installed Libraries</segtitle>
|
---|
| 120 | <segtitle>Installed Directories</segtitle>
|
---|
| 121 |
|
---|
| 122 | <seglistitem>
|
---|
| 123 | <seg>
|
---|
| 124 | None
|
---|
| 125 | </seg>
|
---|
| 126 | <seg>
|
---|
| 127 | None
|
---|
| 128 | </seg>
|
---|
| 129 | <seg>
|
---|
| 130 | /usr/lib/python&python3-majorver;/site-packages/psutil-&psutil-version;.dist-info
|
---|
| 131 | </seg>
|
---|
| 132 | </seglistitem>
|
---|
| 133 | </segmentedlist>
|
---|
| 134 | </sect3>
|
---|
| 135 |
|
---|
| 136 | </sect2>
|
---|