glances_api 0.2.1__py3-none-any.whl

glances_api/__init__.py

@@ -0,0 +1,89 @@
+"""Client to interact with the Glances API."""
+import asyncio
+import logging
+
+import aiohttp
+import async_timeout
+
+from . import exceptions
+
+_LOGGER = logging.getLogger(__name__)
+_RESOURCE = "{schema}://{host}:{port}/api/{version}"
+
+
+class Glances(object):
+    """A class for handling the data retrieval."""
+
+    def __init__(
+        self,
+        loop,
+        session,
+        host="localhost",
+        port=61208,
+        version=2,
+        ssl=False,
+        username=None,
+        password=None,
+    ):
+        """Initialize the connection."""
+        schema = "https" if ssl else "http"
+        self._loop = loop
+        self._session = session
+        self.url = _RESOURCE.format(
+            schema=schema, host=host, port=port, version=version
+        )
+        self.data = None
+        self.values = None
+        self.plugins = None
+        self.username = username
+        self.password = password
+
+    async def get_data(self):
+        """Retrieve the data."""
+        url = "{}/{}".format(self.url, "all")
+
+        try:
+            with async_timeout.timeout(5, loop=self._loop):
+                if self.password is None:
+                    response = await self._session.get(url)
+                else:
+                    auth = aiohttp.BasicAuth(self.username, self.password)
+                    response = await self._session.get(url, auth=auth)
+
+            _LOGGER.debug("Response from Glances API: %s", response.status)
+            print(response.status)
+            print(response.text)
+            self.data = await response.json()
+            _LOGGER.debug(self.data)
+        except (asyncio.TimeoutError, aiohttp.ClientError):
+            _LOGGER.error("Can not load data from Glances API")
+            raise exceptions.GlancesApiConnectionError()
+
+    async def get_metrics(self, element):
+        """Get all the metrics for a monitored element."""
+        await self.get_data()
+        await self.get_plugins()
+
+        if element in self.plugins:
+            self.values = self.data[element]
+        else:
+            raise exceptions.GlancesApiError("Element data not available")
+
+    async def get_plugins(self):
+        """Retrieve the available plugins."""
+        url = "{}/{}".format(self.url, "pluginslist")
+
+        try:
+            with async_timeout.timeout(5, loop=self._loop):
+                if self.password is None:
+                    response = await self._session.get(url)
+                else:
+                    auth = aiohttp.BasicAuth(self.username, self.password)
+                    response = await self._session.get(url, auth=auth)
+
+            _LOGGER.debug("Response from Glances API: %s", response.status)
+            self.plugins = await response.json()
+            _LOGGER.debug(self.plugins)
+        except (asyncio.TimeoutError, aiohttp.ClientError):
+            _LOGGER.error("Can not load plugins from Glances API")
+            raise exceptions.GlancesApiConnectionError()

glances_api/exceptions.py

@@ -0,0 +1,19 @@
+"""Exceptions for the client."""
+
+
+class GlancesApiError(Exception):
+    """General GlancesApiError exception occurred."""
+
+    pass
+
+
+class GlancesApiConnectionError(GlancesApiError):
+    """When a connection error is encountered."""
+
+    pass
+
+
+class GlancesApiNoDataAvailable(GlancesApiError):
+    """When no data is available."""
+
+    pass

glances_api-0.2.1.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-2021 Fabian Affolter <fabian@affolter-engineering.ch>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

glances_api-0.2.1.dist-info/METADATA

@@ -0,0 +1,67 @@
+Metadata-Version: 2.1
+Name: glances-api
+Version: 0.2.1
+Summary: Python API for interacting with Glances.
+Home-page: https://github.com/home-assistant-ecosystem/python-glances-api
+Author: Fabian Affolter
+Author-email: fabian@affolter-engineering.ch
+License: MIT
+Download-URL: https://github.com/home-assistant-ecosystem/python-glances-api/releases
+Platform: UNKNOWN
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Topic :: Utilities
+Requires-Dist: aiohttp (<4,>=3.7.4)
+Requires-Dist: async-timeout (<4)
+
+python-glances-api
+==================
+
+A Python client for interacting with `Glances <https://nicolargo.github.io/glances/>`_.
+
+This module is not official, developed, supported or endorsed by Glances.
+
+Installation
+------------
+
+The module is available from the `Python Package Index <https://pypi.python.org/pypi>`_.
+
+.. code:: bash
+
+    $ pip3 install glances_api
+
+Or on a Fedora-based system or on a CentOS/RHEL machine with has EPEL enabled.
+
+.. code:: bash
+
+    $ sudo dnf -y install python3-glances-api
+
+Usage
+-----
+
+The file ``example.py`` contains an example about how to use this module.
+
+Development
+-----------
+
+For development is recommended to use a ``venv``.
+
+.. code:: bash
+
+    $ python3 -m venv .
+    $ source bin/activate
+    $ python3 setup.py develop
+
+License
+-------
+
+``python-glances-api`` is licensed under MIT, for more details check LICENSE.
+
+

glances_api-0.2.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+glances_api/__init__.py,sha256=txpgnHwBpxSIp9AuFhlR1gDNbJfhl-awUWYBQT-KZ8E,2937
+glances_api/exceptions.py,sha256=4W4Zr-dUtt-g9By-QB_UoqYvq0cmZijFM73jGxoR874,344
+glances_api-0.2.1.dist-info/LICENSE,sha256=2xZES9gdkl1p4_hiSH_OnCSBHdxq0fSjKPE9OmAzHyI,1110
+glances_api-0.2.1.dist-info/METADATA,sha256=f9BG9bst-OD_lxoR3C3y6d68kgIvE_FhWuD2fnsuN64,1751
+glances_api-0.2.1.dist-info/WHEEL,sha256=g4nMs7d-Xl9-xC9XovUrsDHGXt-FT0E17Yqo92DEfvY,92
+glances_api-0.2.1.dist-info/top_level.txt,sha256=2Ue0146zzIXjLpGcsPV0S0tis4D6K96AENPFY7mF8V4,12
+glances_api-0.2.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+glances_api-0.2.1.dist-info/RECORD,,

glances_api-0.2.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.34.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

glances_api-0.2.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+glances_api

glances_api-0.2.1.dist-info/zip-safe

@@ -0,0 +1 @@
+