diff --git a/.travis.yml b/.travis.yml index c05d72a9..a753e9cb 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,6 +4,7 @@ python: - "3.3" - "3.4" - "3.5" + - "3.6" - "pypy" install: - pip install -r requirements.txt diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df00fb9e..765f61c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -147,5 +147,5 @@ included in the project: with a clear title and description against the `develop` branch. **IMPORTANT**: By submitting a patch, you agree to allow the project owners to -license your work under the terms of the [LGPL](LICENSE) (if it +license your work under the terms of the [LGPLv3](COPYING) (if it includes code changes). diff --git a/README.rst b/README.rst index 9e728135..5c12579c 100644 --- a/README.rst +++ b/README.rst @@ -25,29 +25,28 @@ Follow Glances on Twitter: `@nicolargo`_ or `@glances_system`_ Summary ======= -**Glances** is a cross-platform monitoring tool which aims to present a maximum -of information in a minimum of space through a curses or Web based interface. -It can adapt dynamically the displayed information depending on the user -interface size. +**Glances** is a cross-platform monitoring tool which aims to present a +maximum of information in a minimum of space through a curses or Web +based interface. It can adapt dynamically the displayed information +depending on the user interface size. .. image:: https://raw.githubusercontent.com/nicolargo/glances/develop/docs/_static/glances-summary.png -It can also work in client/server mode. Remote monitoring could be done via -terminal, Web interface or API (XMLRPC and RESTful). Stats can also be exported -to files or external time/value databases. +It can also work in client/server mode. Remote monitoring could be done +via terminal, Web interface or API (XML-RPC and RESTful). Stats can also +be exported to files or external time/value databases. .. image:: https://raw.githubusercontent.com/nicolargo/glances/develop/docs/_static/glances-responsive-webdesign.png -Glances is written in Python and uses libraries to grab information from your -system. It is based on an open architecture where developers can add news -plugins or exports modules. +Glances is written in Python and uses libraries to grab information from +your system. It is based on an open architecture where developers can +add new plugins or exports modules. Requirements ============ -- ``python 2.7,>=3.3`` (tested with version 2.7, 3.3, 3.4, 3.5) +- ``python 2.7,>=3.3`` - ``psutil>=2.0.0`` (better with latest version) -- ``setuptools`` Optional dependencies: @@ -127,7 +126,7 @@ To install, simply use ``pip``: *Note*: Python headers are required to install `psutil`_. For example, on Debian/Ubuntu you need to install first the *python-dev* package. For Fedora/CentOS/RHEL install first *python-devel* package. For Windows, -just install PsUtil from the binary installation file. +just install psutil from the binary installation file. You can also install the following libraries in order to use optional features (like the Web interface, exports modules, sensors...): @@ -157,7 +156,9 @@ If you need to install Glances in a specific user location, use: Docker: the funny way --------------------- -A Glances container is available. It will include the latest development HEAD version. You can use it to monitor your server and all your others containers ! +A Glances container is available. It will include the latest development +HEAD version. You can use it to monitor your server and all your others +containers ! Get the Glances container: @@ -171,8 +172,8 @@ Run the container in *console mode*: docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host -it docker.io/nicolargo/glances -Additionally, If you want to use your own glances.conf file, you can create your -own Dockerfile: +Additionally, if you want to use your own glances.conf file, you can +create your own Dockerfile: .. code-block:: console @@ -180,7 +181,8 @@ own Dockerfile: COPY glances.conf /glances/conf/glances.conf CMD python -m glances -C /glances/conf/glances.conf $GLANCES_OPT -Alternatively, you can specify something along the same lines with docker run options: +Alternatively, you can specify something along the same lines with +docker run options: .. code-block:: console @@ -188,7 +190,8 @@ Alternatively, you can specify something along the same lines with docker run op Where ./glances.conf is a local directory containing your glances.conf file. -Run the container in *Web server mode* (notice the GLANCES_OPT environment variable setting parameters for the glances startup command) : +Run the container in *Web server mode* (notice the `GLANCES_OPT` environment +variable setting parameters for the glances startup command): .. code-block:: console @@ -197,18 +200,9 @@ Run the container in *Web server mode* (notice the GLANCES_OPT environment varia GNU/Linux --------- -At the moment, packages exist for the following GNU/Linux distributions: - -- Arch Linux -- Debian -- Fedora/CentOS/RHEL -- Gentoo -- Slackware (SlackBuild) -- Ubuntu -- Void Linux - -So you should be able to install it using your favorite package manager. -Be aware that the Glances version can not be the latest one using this method. +`Glances` is available on many Linux distributions, so you should be +able to install it using your favorite package manager. Be aware that +Glances may not be the latest one using this method. FreeBSD ------- @@ -256,13 +250,6 @@ then just: $ pip install glances -You can also install the following libraries in order to use optional -features (like the Web interface, exports modules, sensors...): - -.. code-block:: console - - pip install bottle requests zeroconf netifaces influxdb elasticsearch potsdb statsd pystache pysnmp pika py-cpuinfo bernhard cassandra scandir - Source ------ @@ -274,13 +261,13 @@ To install Glances from source: $ cd glances-* # python setup.py install -*Note*: Python headers are required to install psutil. For example, -on Debian/Ubuntu you need to install first the *python-dev* package. +*Note*: Python headers are required to install psutil. Chef ---- -An awesome ``Chef`` cookbook is available to monitor your infrastructure: https://supermarket.chef.io/cookbooks/glances (thanks to Antoine Rouyer) +An awesome ``Chef`` cookbook is available to monitor your infrastructure: +https://supermarket.chef.io/cookbooks/glances (thanks to Antoine Rouyer) Puppet ------ @@ -359,7 +346,7 @@ Nicolas Hennion (@nicolargo) License ======= -LGPL. See ``COPYING`` for more details. +LGPLv3. See ``COPYING`` for more details. .. _psutil: https://github.com/giampaolo/psutil .. _glancesautoinstall: https://github.com/nicolargo/glancesautoinstall diff --git a/glances/__init__.py b/glances/__init__.py index 533d2e4a..2d06da77 100644 --- a/glances/__init__.py +++ b/glances/__init__.py @@ -29,7 +29,7 @@ import sys # Global name __version__ = '2.8.1_DEVELOP' __author__ = 'Nicolas Hennion ' -__license__ = 'LGPL' +__license__ = 'LGPLv3' # Import psutil try: diff --git a/setup.py b/setup.py index 6adda9ad..0ed41b72 100755 --- a/setup.py +++ b/setup.py @@ -37,6 +37,14 @@ def get_data_files(): return data_files +def get_install_requires(): + requires = ['psutil>=2.0.0'] + if sys.platform.startswith('win'): + requires.append('bottle') + + return requires + + class tests(Command): user_options = [] @@ -66,9 +74,9 @@ setup( author='Nicolas Hennion', author_email='nicolas@nicolargo.com', url='https://github.com/nicolargo/glances', - license="LGPL", + license='LGPLv3', keywords="cli curses monitoring system", - install_requires=['psutil>=2.0.0'], + install_requires=get_install_requires(), extras_require={ 'ACTION': ['pystache'], 'BATINFO': ['batinfo'], @@ -108,6 +116,7 @@ setup( 'Programming Language :: Python :: 3.3', 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', 'Topic :: System :: Monitoring' ] )