glances_api 0.1.0__tar.gz → 0.2.1__tar.gz

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

@@ -0,0 +1,29 @@
+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

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

{glances_api-0.1.0 → glances_api-0.2.1}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2018 Fabian Affolter
+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

glances_api-0.2.1/MANIFEST.in

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

{glances_api-0.1.0 → glances_api-0.2.1}/PKG-INFO

@@ -1,16 +1,16 @@
 Metadata-Version: 1.1
 Name: glances_api
-Version: 0.1.0
+Version: 0.2.1
 Summary: Python API for interacting with Glances.
-Home-page: https://github.com/fabaff/python-glances-api
+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/fabaff/python-glances-api/releases
+Download-URL: https://github.com/home-assistant-ecosystem/python-glances-api/releases
 Description: python-glances-api
         ==================
         
-        Python API for interacting with `Glances <https://nicolargo.github.io/glances/>`_.
+        A Python client for interacting with `Glances <https://nicolargo.github.io/glances/>`_.
         
         This module is not official, developed, supported or endorsed by Glances.
         
@@ -23,6 +23,12 @@ Description: python-glances-api
         
             $ 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
         -----
         
@@ -35,7 +41,7 @@ Description: python-glances-api
         
         .. code:: bash
         
-            $ python3.6 -m venv .
+            $ python3 -m venv .
             $ source bin/activate
             $ python3 setup.py develop
         

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

@@ -1,7 +1,7 @@
 python-glances-api
 ==================
 
-Python API for interacting with `Glances <https://nicolargo.github.io/glances/>`_.
+A Python client for interacting with `Glances <https://nicolargo.github.io/glances/>`_.
 
 This module is not official, developed, supported or endorsed by Glances.
 
@@ -14,6 +14,12 @@ The module is available from the `Python Package Index <https://pypi.python.org/
 
     $ 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
 -----
 
@@ -26,7 +32,7 @@ For development is recommended to use a ``venv``.
 
 .. code:: bash
 
-    $ python3.6 -m venv .
+    $ python3 -m venv .
     $ source bin/activate
     $ python3 setup.py develop
 

glances_api-0.2.1/example.py

@@ -0,0 +1,31 @@
+"""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.1.0 → glances_api-0.2.1}/glances_api/__init__.py

@@ -1,8 +1,4 @@
-"""
-Copyright (c) 2017-2018 Fabian Affolter <fabian@affolter-engineering.ch>
-
-Licensed under MIT. All rights reserved.
-"""
+"""Client to interact with the Glances API."""
 import asyncio
 import logging
 
@@ -12,30 +8,51 @@ import async_timeout
 from . import exceptions
 
 _LOGGER = logging.getLogger(__name__)
-_RESOURCE = 'http://{host}:{port}/api/{version}'
+_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):
+    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(host=host, port=port, version=version)
+        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')
+        url = "{}/{}".format(self.url, "all")
 
         try:
             with async_timeout.timeout(5, loop=self._loop):
-                response = await self._session.get(url)
+                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):
@@ -54,11 +71,15 @@ class Glances(object):
 
     async def get_plugins(self):
         """Retrieve the available plugins."""
-        url = '{}/{}'.format(self.url, 'pluginslist')
+        url = "{}/{}".format(self.url, "pluginslist")
 
         try:
             with async_timeout.timeout(5, loop=self._loop):
-                response = await self._session.get(url)
+                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()

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

@@ -1,12 +1,8 @@
-"""
-Copyright (c) 2017-2018 Fabian Affolter <fabian@affolter-engineering.ch>
-
-Licensed under MIT. All rights reserved.
-"""
+"""Exceptions for the client."""
 
 
 class GlancesApiError(Exception):
-    """General GlancesApiErrorError exception occurred."""
+    """General GlancesApiError exception occurred."""
 
     pass
 

{glances_api-0.1.0 → glances_api-0.2.1}/glances_api.egg-info/PKG-INFO

@@ -1,16 +1,16 @@
 Metadata-Version: 1.1
 Name: glances-api
-Version: 0.1.0
+Version: 0.2.1
 Summary: Python API for interacting with Glances.
-Home-page: https://github.com/fabaff/python-glances-api
+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/fabaff/python-glances-api/releases
+Download-URL: https://github.com/home-assistant-ecosystem/python-glances-api/releases
 Description: python-glances-api
         ==================
         
-        Python API for interacting with `Glances <https://nicolargo.github.io/glances/>`_.
+        A Python client for interacting with `Glances <https://nicolargo.github.io/glances/>`_.
         
         This module is not official, developed, supported or endorsed by Glances.
         
@@ -23,6 +23,12 @@ Description: python-glances-api
         
             $ 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
         -----
         
@@ -35,7 +41,7 @@ Description: python-glances-api
         
         .. code:: bash
         
-            $ python3.6 -m venv .
+            $ python3 -m venv .
             $ source bin/activate
             $ python3 setup.py develop
         

{glances_api-0.1.0 → glances_api-0.2.1}/glances_api.egg-info/SOURCES.txt

@@ -1,7 +1,11 @@
+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-0.2.1/glances_api.egg-info/requires.txt

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

glances_api-0.2.1/requirements.txt

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

glances_api-0.2.1/setup.py

@@ -0,0 +1,41 @@
+#!/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",
+    ],
+)

glances_api-0.1.0/MANIFEST.in

@@ -1 +0,0 @@
-include LICENSE

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

@@ -1,2 +0,0 @@
-aiohttp
-async_timeout

glances_api-0.1.0/setup.py

@@ -1,49 +0,0 @@
-#!/usr/bin/env python3
-"""
-Copyright (c) 2017-2018 Fabian Affolter <fabian@affolter-engineering.ch>
-
-Licensed under MIT. All rights reserved.
-"""
-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 f:
-    long_description = f.read()
-
-if sys.argv[-1] == 'publish':
-    os.system('python3 setup.py sdist upload')
-    sys.exit()
-
-setup(
-    name='glances_api',
-    version='0.1.0',
-    description='Python API for interacting with Glances.',
-    long_description=long_description,
-    url='https://github.com/fabaff/python-glances-api',
-    download_url='https://github.com/fabaff/python-glances-api/releases',
-    author='Fabian Affolter',
-    author_email='fabian@affolter-engineering.ch',
-    license='MIT',
-    install_requires=['aiohttp', 'async_timeout'],
-    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',
-    ],
-)