Documentation is unclear how to get Docker information #1386 and also add a all target to the Pip install in order to install all dependencies

This commit is contained in:
nicolargo 2019-01-20 10:56:30 +01:00
parent fede502478
commit 62debf21b4
6 changed files with 43 additions and 28 deletions

5
NEWS
View File

@ -14,6 +14,11 @@ Bugs corrected:
* ... * ...
Others:
* Documentation is unclear how to get Docker information #1386
* Add 'all' target to the Pip install (install all dependencies)
Version 3.1 Version 3.1
=========== ===========

View File

@ -6,6 +6,12 @@ Docker
If you use ``Docker``, Glances can help you to monitor your containers. If you use ``Docker``, Glances can help you to monitor your containers.
Glances uses the Docker API through the `docker-py`_ library. Glances uses the Docker API through the `docker-py`_ library.
You can install this dependency using:
.. code-block:: console
pip install glances[docker]
.. image:: ../_static/docker.png .. image:: ../_static/docker.png
It is possible to define limits and actions from the configuration file It is possible to define limits and actions from the configuration file

View File

@ -22,7 +22,7 @@ features (like the Web interface, export modules...):
.. code-block:: console .. code-block:: console
pip install glances[action,browser,cloud,cpuinfo,chart,docker,export,folders,gpu,ip,raid,snmp,web,wifi] pip install glances[all]
To upgrade Glances and all its dependencies to the latest versions: To upgrade Glances and all its dependencies to the latest versions:
@ -30,7 +30,7 @@ To upgrade Glances and all its dependencies to the latest versions:
pip install --upgrade glances pip install --upgrade glances
pip install --upgrade psutil pip install --upgrade psutil
pip install --upgrade glances[...] pip install --upgrade glances[all]
For additional installation methods, read the official `README`_ file. For additional installation methods, read the official `README`_ file.

View File

@ -1,10 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
<<<<<<< HEAD .TH "GLANCES" "1" "Jan 20, 2019" "3.1.1b0" "Glances"
.TH "GLANCES" "1" "Jan 19, 2019" "3.1.0" "Glances"
=======
.TH "GLANCES" "1" "Sep 29, 2018" "3.0.2" "Glances"
>>>>>>> master
.SH NAME .SH NAME
glances \- An eye on your system glances \- An eye on your system
. .

View File

@ -27,7 +27,7 @@ import signal
import sys import sys
# Global name # Global name
__version__ = '3.1.1_beta' __version__ = '3.1.1b0'
__author__ = 'Nicolas Hennion <nicolas@nicolargo.com>' __author__ = 'Nicolas Hennion <nicolas@nicolargo.com>'
__license__ = 'LGPLv3' __license__ = 'LGPLv3'

View File

@ -49,6 +49,33 @@ def get_install_requires():
return requires return requires
def get_install_extras_require():
extras_require = {
'action': ['pystache'],
# Zeroconf 0.19.1 is the latest one compatible with Python 2 (issue #1293)
'browser': ['zeroconf==0.19.1' if PY2 else 'zeroconf>=0.19.1'],
'cloud': ['requests'],
'cpuinfo': ['py-cpuinfo'],
'docker': ['docker>=2.0.0'],
'export': ['bernhard', 'cassandra-driver', 'couchdb', 'elasticsearch',
'influxdb>=1.0.0', 'kafka-python', 'pika', 'paho-mqtt', 'potsdb',
'prometheus_client', 'pyzmq', 'statsd'],
'folders': ['scandir'], # python_version<"3.5"
'gpu': ['nvidia-ml-py3'], # python_version=="2.7"
'graph': ['pygal'],
'ip': ['netifaces'],
'raid': ['pymdstat'],
'smart': ['pySMART.smartx'],
'snmp': ['pysnmp'],
'web': ['bottle', 'requests'],
'wifi': ['wifi']
}
# Add automatically the 'all' target
extras_require.update({'all': [i[0] for i in extras_require.values()]})
return extras_require
class tests(Command): class tests(Command):
user_options = [] user_options = []
@ -82,26 +109,7 @@ setup(
keywords="cli curses monitoring system", keywords="cli curses monitoring system",
python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*", python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
install_requires=get_install_requires(), install_requires=get_install_requires(),
extras_require={ extras_require=get_install_extras_require(),
'action': ['pystache'],
# Zeroconf 0.19.1 is the latest one compatible with Python 2 (issue #1293)
'browser': ['zeroconf==0.19.1' if PY2 else 'zeroconf>=0.19.1'],
'cloud': ['requests'],
'cpuinfo': ['py-cpuinfo'],
'docker': ['docker>=2.0.0'],
'export': ['bernhard', 'cassandra-driver', 'couchdb', 'elasticsearch',
'influxdb>=1.0.0', 'kafka-python', 'pika', 'paho-mqtt', 'potsdb',
'prometheus_client', 'pyzmq', 'statsd'],
'folders': ['scandir'], # python_version<"3.5"
'gpu': ['nvidia-ml-py3'], # python_version=="2.7"
'graph': ['pygal'],
'ip': ['netifaces'],
'raid': ['pymdstat'],
'smart': ['pySMART.smartx'],
'snmp': ['pysnmp'],
'web': ['bottle', 'requests'],
'wifi': ['wifi']
},
packages=['glances'], packages=['glances'],
include_package_data=True, include_package_data=True,
data_files=get_data_files(), data_files=get_data_files(),