summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authornicolargo <nicolas@nicolargo.com>2017-01-01 14:14:20 +0100
committernicolargo <nicolas@nicolargo.com>2017-01-01 14:14:20 +0100
commitb80ff98de32b5731b5e42aaecbfeb996f4d0890d (patch)
tree8c18ed4f1fcb1e5dd541326e07fcb59d28e23e58
parentc61ad18f472b5eee80b55899a4455a2ec37ae4fa (diff)
Update docs and requirements files
-rw-r--r--README.rst38
-rw-r--r--docs/install.rst8
-rw-r--r--docs/man/glances.14
-rw-r--r--optional-requirements.txt3
4 files changed, 35 insertions, 18 deletions
diff --git a/README.rst b/README.rst
index e7ec368c..4c2ae781 100644
--- a/README.rst
+++ b/README.rst
@@ -28,30 +28,36 @@ Requirements
============
- ``python 2.7,>=3.3`` (tested with version 2.7, 3.3, 3.4, 3.5)
-- ``psutil>=2.0.0``
+- ``psutil>=2.0.0`` (better with latest version)
- ``setuptools``
Optional dependencies:
-- ``bottle`` (for Web server mode)
-- ``py3sensors`` (for hardware monitoring support) [Linux-only]
-- ``hddtemp`` (for HDD temperature monitoring support) [Linux-only]
- ``batinfo`` (for battery monitoring support) [Linux-only]
-- ``pymdstat`` (for RAID support) [Linux-only]
-- ``pysnmp`` (for SNMP support)
-- ``zeroconf`` (for the autodiscover mode)
-- ``netifaces`` (for the IP plugin)
-- ``influxdb`` (for the InfluxDB export module)
+- ``bernhard`` (for the Riemann export module)
+- ``bottle`` (for Web server mode)
- ``cassandra-driver`` (for the Cassandra export module)
-- ``statsd`` (for the StatsD export module)
-- ``pystache`` (for the action script feature)
+- ``couchdb`` (for the CouchDB export module)
- ``docker-py`` (for the Docker monitoring support) [Linux-only]
+- ``elasticsearch`` (for the Elastic Search export module)
+- ``hddtemp`` (for HDD temperature monitoring support) [Linux-only]
+- ``influxdb`` (for the InfluxDB export module)
- ``matplotlib`` (for graphical/chart support)
+- ``netifaces`` (for the IP plugin)
+- ``nvidia-ml-py`` (for the GPU plugin)
- ``pika`` (for the RabbitMQ/ActiveMQ export module)
-- ``bernhard`` (for the Riemann export module)
+- ``potsdb`` (for the OpenTSDB export module)
+- ``py3sensors`` (for hardware monitoring support) [Linux-only]
- ``py-cpuinfo`` (for the Quicklook CPU info module)
+- ``pymdstat`` (for RAID support) [Linux-only]
+- ``pysnmp`` (for SNMP support)
+- ``pystache`` (for the action script feature)
+- ``pyzmq`` (for the ZeroMQ export module)
+- ``requests`` (for the Ports plugin)
- ``scandir`` (for the Folders plugin) [Only for Python < 3.5]
+- ``statsd`` (for the StatsD export module)
- ``wifi`` (for the wifi plugin) [Linux-only]
+- ``zeroconf`` (for the autodiscover mode)
*Note for Python 2.6 users*
@@ -110,14 +116,18 @@ features (like the Web interface, exports modules, sensors...):
.. code-block:: console
- pip install bottle requests batinfo https://bitbucket.org/gleb_zhulik/py3sensors/get/tip.tar.gz zeroconf netifaces pymdstat influxdb elasticsearch potsdb statsd pystache docker-py pysnmp pika py-cpuinfo bernhard cassandra-driver scandir pyzmq
+ curl -o /tmp/optional-requirements.txt https://raw.githubusercontent.com/nicolargo/glances/master/optional-requirements.txt
+ pip install -r /tmp/optional-requirements.txt
To upgrade Glances to the latest version:
.. code-block:: console
pip install --upgrade glances
- pip install --upgrade bottle requests batinfo https://bitbucket.org/gleb_zhulik/py3sensors/get/tip.tar.gz zeroconf netifaces pymdstat influxdb elasticsearch potsdb statsd pystache docker-py pysnmp pika py-cpuinfo bernhard cassandra-driver scandir pyzmq
+ curl -o /tmp/requirements.txt https://raw.githubusercontent.com/nicolargo/glances/master/requirements.txt
+ pip install --upgrade /tmp/requirements.txt
+ curl -o /tmp/optional-requirements.txt https://raw.githubusercontent.com/nicolargo/glances/master/optional-requirements.txt
+ pip install --upgrade /tmp/optional-requirements.txt
If you need to install Glances in a specific user location, use:
diff --git a/docs/install.rst b/docs/install.rst
index cc36c12b..56ac63d3 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -22,14 +22,18 @@ features (like the Web interface, exports modules, sensors...):
.. code-block:: console
- pip install bottle requests batinfo py3sensors zeroconf netifaces pymdstat influxdb elasticsearch potsdb statsd pystache docker-py pysnmp pika py-cpuinfo bernhard cassandra scandir couchdb pyzmq wifi
+ curl -o /tmp/optional-requirements.txt https://raw.githubusercontent.com/nicolargo/glances/master/optional-requirements.txt
+ pip install -r /tmp/optional-requirements.txt
To upgrade Glances and all its dependencies to the latests versions:
.. code-block:: console
- pip install --upgrade bottle requests batinfo py3sensors zeroconf netifaces pymdstat influxdb elasticsearch potsdb statsd pystache docker-py pysnmp pika py-cpuinfo bernhard cassandra scandir couchdb pyzmq wifi
pip install --upgrade glances
+ curl -o /tmp/requirements.txt https://raw.githubusercontent.com/nicolargo/glances/master/requirements.txt
+ pip install --upgrade /tmp/requirements.txt
+ curl -o /tmp/optional-requirements.txt https://raw.githubusercontent.com/nicolargo/glances/master/optional-requirements.txt
+ pip install --upgrade /tmp/optional-requirements.txt
For additionnal installation methods, read the official `README`_ file.
diff --git a/docs/man/glances.1 b/docs/man/glances.1
index a3461421..3c0cc667 100644
--- a/docs/man/glances.1
+++ b/docs/man/glances.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "GLANCES" "1" "Dec 31, 2016" "2.8_DEVELOP" "Glances"
+.TH "GLANCES" "1" "Jan 01, 2017" "2.8_DEVELOP" "Glances"
.SH NAME
glances \- An eye on your system
.
@@ -666,6 +666,6 @@ $ glances \-\-browser
.sp
Nicolas Hennion aka Nicolargo <\fI\%contact@nicolargo.com\fP>
.SH COPYRIGHT
-2016, Nicolas Hennion
+2017, Nicolas Hennion
.\" Generated by docutils manpage writer.
.
diff --git a/optional-requirements.txt b/optional-requirements.txt
index 264c64aa..e1f65005 100644
--- a/optional-requirements.txt
+++ b/optional-requirements.txt
@@ -5,7 +5,9 @@ cassandra-driver
couchdb
docker-py
elasticsearch
+hddtemp
influxdb
+matplotlib
netifaces
nvidia-ml-py
pika
@@ -18,4 +20,5 @@ pyzmq
requests
scandir
statsd
+wifi
zeroconf