glances_api 0.2.1__tar.gz → 0.3.3__tar.gz

glances_api-0.3.3/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.1
+Name: glances-api
+Version: 0.3.3
+Summary: Python API for interacting with Glances
+Home-page: https://github.com/home-assistant-ecosystem/python-glances-api
+License: MIT
+Author: Fabian Affolter
+Author-email: fabian@affolter-engineering.ch
+Requires-Python: >=3.8,<4.0
+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
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Topic :: Utilities
+Requires-Dist: httpx (>=0.20,<1)
+Project-URL: Repository, https://github.com/home-assistant-ecosystem/python-glances-api/releases
+Description-Content-Type: text/x-rst
+
+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.
+
+License
+-------
+
+``python-glances-api`` is licensed under MIT, for more details check LICENSE.
+

{glances_api-0.2.1 → glances_api-0.3.3}/README.rst

@@ -25,17 +25,6 @@ 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
 -------
 

glances_api-0.3.3/glances_api/__init__.py

@@ -0,0 +1,78 @@
+"""Client to interact with the Glances API."""
+import asyncio
+import logging
+
+import httpx
+
+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,
+        host="localhost",
+        port=61208,
+        version=2,
+        ssl=False,
+        verify_ssl=True,
+        username=None,
+        password=None,
+    ):
+        """Initialize the connection."""
+        schema = "https" if ssl else "http"
+        self.url = _RESOURCE.format(
+            schema=schema, host=host, port=port, version=version
+        )
+        self.plugins = None
+        self.values = None
+        self.username = username
+        self.password = password
+        self.verify_ssl = verify_ssl
+
+    async def get_data(self, endpoint):
+        """Retrieve the data."""
+        url = "{}/{}".format(self.url, endpoint)
+
+        try:
+            async with httpx.AsyncClient(verify=self.verify_ssl) as client:
+                if self.password is None:
+                    response = await client.get(str(url))
+                else:
+                    response = await client.get(
+                        str(url), auth=(self.username, self.password)
+                    )
+        except httpx.ConnectError:
+            raise exceptions.GlancesApiConnectionError(f"Connection to {url} failed")
+
+        if response.status_code == httpx.codes.UNAUTHORIZED:
+            raise exceptions.GlancesApiAuthorizationError(
+                "Please check your credentials"
+            )
+
+        if response.status_code == httpx.codes.OK:
+            try:
+                _LOGGER.debug(response.json())
+                if endpoint == "all":
+                    self.data = response.json()
+                if endpoint == "pluginslist":
+                    self.plugins = response.json()
+            except TypeError:
+                _LOGGER.error("Can not load data from Glances")
+                raise exceptions.GlancesApiConnectionError(
+                    "Unable to get the data from Glances"
+                )
+
+    async def get_metrics(self, element):
+        """Get all the metrics for a monitored element."""
+        await self.get_data("all")
+        await self.get_data("pluginslist")
+
+        if element in self.plugins:
+            self.values = self.data[element]
+        else:
+            raise exceptions.GlancesApiError("Element data not available")

{glances_api-0.2.1 → glances_api-0.3.3}/glances_api/exceptions.py

@@ -6,12 +6,14 @@ class GlancesApiError(Exception):
 
     pass
 
-
 class GlancesApiConnectionError(GlancesApiError):
     """When a connection error is encountered."""
 
     pass
+class GlancesApiAuthorizationError(GlancesApiError):
+    """When a connection error is encountered."""
 
+    pass
 
 class GlancesApiNoDataAvailable(GlancesApiError):
     """When no data is available."""

glances_api-0.3.3/pyproject.toml

@@ -0,0 +1,33 @@
+[tool.poetry]
+name = "glances_api"
+version = "0.3.3"
+description = "Python API for interacting with Glances"
+authors = ["Fabian Affolter <fabian@affolter-engineering.ch>"]
+homepage = "https://github.com/home-assistant-ecosystem/python-glances-api"
+repository = "https://github.com/home-assistant-ecosystem/python-glances-api/releases"
+readme = "README.rst"
+license = "MIT"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX",
+    "Topic :: Utilities",
+]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+httpx = ">=0.20,<1"
+
+[tool.poetry.dev-dependencies]
+black = "^21.12b0"
+pytest = "^6.2.5"
+pytest-httpx = ">0.15,<1"
+pytest-asyncio = "^0.16.0"
+isort = "^5.10.0"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

glances_api-0.3.3/setup.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+from setuptools import setup
+
+packages = \
+['glances_api']
+
+package_data = \
+{'': ['*']}
+
+install_requires = \
+['httpx>=0.20,<1']
+
+setup_kwargs = {
+    'name': 'glances-api',
+    'version': '0.3.3',
+    'description': 'Python API for interacting with Glances',
+    'long_description': 'python-glances-api\n==================\n\nA Python client for interacting with `Glances <https://nicolargo.github.io/glances/>`_.\n\nThis module is not official, developed, supported or endorsed by Glances.\n\nInstallation\n------------\n\nThe module is available from the `Python Package Index <https://pypi.python.org/pypi>`_.\n\n.. code:: bash\n\n    $ pip3 install glances_api\n\nOr on a Fedora-based system or on a CentOS/RHEL machine with has EPEL enabled.\n\n.. code:: bash\n\n    $ sudo dnf -y install python3-glances-api\n\nUsage\n-----\n\nThe file ``example.py`` contains an example about how to use this module.\n\nLicense\n-------\n\n``python-glances-api`` is licensed under MIT, for more details check LICENSE.\n',
+    'author': 'Fabian Affolter',
+    'author_email': 'fabian@affolter-engineering.ch',
+    'maintainer': None,
+    'maintainer_email': None,
+    'url': 'https://github.com/home-assistant-ecosystem/python-glances-api',
+    'packages': packages,
+    'package_data': package_data,
+    'install_requires': install_requires,
+    'python_requires': '>=3.8,<4.0',
+}
+
+
+setup(**setup_kwargs)

glances_api-0.2.1/.github/workflows/python-package.yml

@@ -1,29 +0,0 @@
-name: Python package and lint
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: [3.5, 3.6, 3.7, 3.8]
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Black Code Formatter
-      uses: lgeiger/black-action@v1.0.1

glances_api-0.2.1/CHANGES.rst

@@ -1,10 +0,0 @@
-Changes
-=======
-
-20181121 - 0.2.0
-----------------
-- Support for HTTP Basic authentication
-
-20180814 - 0.1.0
-----------------
-- Initial release

glances_api-0.2.1/MANIFEST.in

@@ -1,2 +0,0 @@
-include LICENSE
-include CHANGES.rst

glances_api-0.2.1/PKG-INFO

@@ -1,63 +0,0 @@
-Metadata-Version: 1.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
-Description: 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.
-        
-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

glances_api-0.2.1/example.py

@@ -1,31 +0,0 @@
-"""Sample script to use the Python API client for Glances."""
-import asyncio
-
-import aiohttp
-
-from glances_api import Glances
-
-HOST = "127.0.0.1"
-VERSION = 3
-
-
-async def main():
-    """The main part of the example script."""
-    async with aiohttp.ClientSession() as session:
-        data = Glances(loop, session, version=VERSION)
-
-        # Get the metrics for the memory
-        await data.get_metrics("mem")
-
-        # Print the values
-        print("Memory values:", data.values)
-
-        # Get the metrics about the disks
-        await data.get_metrics("diskio")
-
-        # Print the values
-        print("Disk values:", data.values)
-
-
-loop = asyncio.get_event_loop()
-loop.run_until_complete(main())

glances_api-0.2.1/glances_api/__init__.py

@@ -1,89 +0,0 @@
-"""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-0.2.1/glances_api.egg-info/PKG-INFO

@@ -1,63 +0,0 @@
-Metadata-Version: 1.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
-Description: 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.
-        
-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

glances_api-0.2.1/glances_api.egg-info/SOURCES.txt

@@ -1,16 +0,0 @@
-CHANGES.rst
-LICENSE
-MANIFEST.in
-README.rst
-example.py
-requirements.txt
-setup.py
-.github/workflows/python-package.yml
-glances_api/__init__.py
-glances_api/exceptions.py
-glances_api.egg-info/PKG-INFO
-glances_api.egg-info/SOURCES.txt
-glances_api.egg-info/dependency_links.txt
-glances_api.egg-info/requires.txt
-glances_api.egg-info/top_level.txt
-glances_api.egg-info/zip-safe

glances_api-0.2.1/glances_api.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

glances_api-0.2.1/glances_api.egg-info/requires.txt

@@ -1,2 +0,0 @@
-aiohttp<4,>=3.7.4
-async_timeout<4

glances_api-0.2.1/glances_api.egg-info/top_level.txt

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

glances_api-0.2.1/glances_api.egg-info/zip-safe

@@ -1 +0,0 @@
-

glances_api-0.2.1/requirements.txt

@@ -1,2 +0,0 @@
-# python-glances-api requirements. Use setup.py for the dependencies.
-.

glances_api-0.2.1/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

glances_api-0.2.1/setup.py

@@ -1,41 +0,0 @@
-#!/usr/bin/env python3
-"""Set up the Python API client for Glances."""
-import os
-import sys
-
-try:
-    from setuptools import setup
-except ImportError:
-    from distutils.core import setup
-
-here = os.path.abspath(os.path.dirname(__file__))
-
-with open(os.path.join(here, "README.rst"), encoding="utf-8") as readme_file:
-    long_description = readme_file.read()
-
-setup(
-    name="glances_api",
-    version="0.2.1",
-    description="Python API for interacting with Glances.",
-    long_description=long_description,
-    url="https://github.com/home-assistant-ecosystem/python-glances-api",
-    download_url="https://github.com/home-assistant-ecosystem/python-glances-api/releases",
-    author="Fabian Affolter",
-    author_email="fabian@affolter-engineering.ch",
-    license="MIT",
-    install_requires=["aiohttp>=3.7.4,<4", "async_timeout<4"],
-    packages=["glances_api"],
-    zip_safe=True,
-    classifiers=[
-        "Development Status :: 3 - Alpha",
-        "Environment :: Console",
-        "Intended Audience :: Developers",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: MacOS :: MacOS X",
-        "Operating System :: Microsoft :: Windows",
-        "Operating System :: POSIX",
-        "Programming Language :: Python :: 3.5",
-        "Programming Language :: Python :: 3.6",
-        "Topic :: Utilities",
-    ],
-)