pythonkuma 0.0.0rc0__tar.gz

pythonkuma-0.0.0rc0/.gitignore

@@ -0,0 +1,131 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+test.py

pythonkuma-0.0.0rc0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Bacon
+
+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.

pythonkuma-0.0.0rc0/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.4
+Name: pythonkuma
+Version: 0.0.0rc0
+Summary: Simple Python wrapper for Uptime Kuma
+Project-URL: Source, https://github.com/tr4nt0r/pythonkuma
+Author-email: Manfred Dennerlein Rodelo <manfred@dennerlein.name>, Jayakorn Karikan <jayakornk@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Requires-Dist: aiohttp>=3.12.9
+Requires-Dist: prometheus-client>=0.21.0
+Provides-Extra: dev
+Requires-Dist: ruff==0.11.13; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pythonkuma
+Simple Python wrapper for Uptime Kuma
+
+## Installation
+
+```shell
+pip install pythonkuma
+```
+
+## Example
+
+```python
+import asyncio
+
+import aiohttp
+
+from pythonkuma import UptimeKuma
+
+URL = ""
+USERNAME = ""
+PASSWORD = ""
+
+
+async def main():
+
+    async with aiohttp.ClientSession() as session:
+        uptime_kuma = UptimeKuma(session, URL, USERNAME, PASSWORD)
+        response = await uptime_kuma.async_get_monitors()
+        print(response.data)
+
+
+asyncio.run(main())
+
+```
+
+## Credit
+
+This library is a fork of **pyuptimekuma** by [@jayakornk](https://github.com/jayakornk)

pythonkuma-0.0.0rc0/README.md

@@ -0,0 +1,38 @@
+# pythonkuma
+Simple Python wrapper for Uptime Kuma
+
+## Installation
+
+```shell
+pip install pythonkuma
+```
+
+## Example
+
+```python
+import asyncio
+
+import aiohttp
+
+from pythonkuma import UptimeKuma
+
+URL = ""
+USERNAME = ""
+PASSWORD = ""
+
+
+async def main():
+
+    async with aiohttp.ClientSession() as session:
+        uptime_kuma = UptimeKuma(session, URL, USERNAME, PASSWORD)
+        response = await uptime_kuma.async_get_monitors()
+        print(response.data)
+
+
+asyncio.run(main())
+
+```
+
+## Credit
+
+This library is a fork of **pyuptimekuma** by [@jayakornk](https://github.com/jayakornk)

pythonkuma-0.0.0rc0/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["hatchling", "hatch-regex-commit"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pythonkuma"
+dynamic = ["version"]
+description = "Simple Python wrapper for Uptime Kuma"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.12"
+authors = [
+    { name = "Manfred Dennerlein Rodelo", email = "manfred@dennerlein.name" },
+    { name = "Jayakorn Karikan", email = "jayakornk@gmail.com" },
+]
+classifiers = [
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+]
+dependencies = [
+    "aiohttp>=3.12.9",
+    "prometheus-client>=0.21.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "ruff==0.11.13",
+]
+
+[project.urls]
+Source = "https://github.com/tr4nt0r/pythonkuma"
+
+[tool.hatch.version]
+source = "regex_commit"
+commit_extra_args = ["-e"]
+path = "pythonkuma/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/pythonkuma",
+]
+
+[tool.hatch.envs.hatch-static-analysis]
+dependencies = ["ruff==0.11.13"]
+config-path = "ruff.toml"
+
+[tool.pytest.ini_options]
+addopts = "--cov=pythonkuma/ --cov-report=term-missing"
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope="module"
+testpaths = ["tests"]
+pythonpath = ["pythonkuma"]
+
+[tool.hatch.envs.hatch-test]
+extra-dependencies = [
+  "pytest-cov"
+]

pythonkuma-0.0.0rc0/pythonkuma/__init__.py

@@ -0,0 +1,21 @@
+"""Python API wrapper for Uptime Kuma."""
+
+from .exceptions import (
+    UptimeKumaAuthenticationException,
+    UptimeKumaConnectionException,
+    UptimeKumaException,
+)
+from .models import MonitorType, UptimeKumaApiResponse, UptimeKumaMonitor
+from .uptimekuma import UptimeKuma
+
+__version__ = "0.0.0rc0"
+
+__all__ = [
+    "MonitorType",
+    "UptimeKuma",
+    "UptimeKumaApiResponse",
+    "UptimeKumaAuthenticationException",
+    "UptimeKumaConnectionException",
+    "UptimeKumaException",
+    "UptimeKumaMonitor",
+]

pythonkuma-0.0.0rc0/pythonkuma/const.py

@@ -0,0 +1,5 @@
+"""Uptime Kuma constants."""
+
+from logging import Logger, getLogger
+
+LOGGER: Logger = getLogger(__package__)

pythonkuma-0.0.0rc0/pythonkuma/decorator.py

@@ -0,0 +1,71 @@
+"""Decorator for Uptime Kuma"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import aiohttp
+
+from . import exceptions
+from .const import LOGGER
+from .models import UptimeKumaApiResponse
+
+if TYPE_CHECKING:
+    from .uptimekuma import UptimeKuma
+
+
+def api_request(api_path: str, method: str = "GET"):
+    """Decorator for Uptime Kuma API request"""
+
+    def decorator(func):
+        """Decorator"""
+
+        async def wrapper(*args, **kwargs):
+            """Wrapper"""
+            client: UptimeKuma = args[0]
+            url = f"{client._base_url}{api_path}"
+            LOGGER.debug("Requesting %s", url)
+            try:
+                request = await client._session.request(
+                    method=method,
+                    url=url,
+                    timeout=aiohttp.ClientTimeout(total=10),
+                    auth=aiohttp.BasicAuth(client._username, client._password),
+                )
+
+                if request.status != 200:
+                    raise exceptions.UptimeKumaConnectionException(
+                        f"Request for '{url}' failed with status code '{request.status}'"
+                    )
+
+                result = await request.text()
+            except aiohttp.ClientError as exception:
+                raise exceptions.UptimeKumaConnectionException(
+                    f"Request exception for '{url}' with - {exception}"
+                ) from exception
+
+            except TimeoutError:
+                raise exceptions.UptimeKumaConnectionException(f"Request timeout for '{url}'") from None
+
+            except exceptions.UptimeKumaConnectionException as exception:
+                raise exceptions.UptimeKumaConnectionException(exception) from exception
+
+            except exceptions.UptimeKumaException as exception:
+                raise exceptions.UptimeKumaException(exception) from exception
+
+            except (Exception, BaseException) as exception:
+                raise exceptions.UptimeKumaException(
+                    f"Unexpected exception for '{url}' with - {exception}"
+                ) from exception
+
+            LOGGER.debug("Requesting %s returned %s", url, result)
+
+            response = UptimeKumaApiResponse.from_prometheus(
+                {"monitors": result, "_api_path": api_path, "_method": method}
+            )
+
+            return response
+
+        return wrapper
+
+    return decorator

pythonkuma-0.0.0rc0/pythonkuma/exceptions.py

@@ -0,0 +1,13 @@
+"""Uptime Kuma exceptions."""
+
+
+class UptimeKumaException(Exception):
+    """Base Uptime Kuma exception."""
+
+
+class UptimeKumaConnectionException(UptimeKumaException):
+    """Uptime Kuma connection exception."""
+
+
+class UptimeKumaAuthenticationException(UptimeKumaException):
+    """Uptime Kuma authentication exception."""

pythonkuma-0.0.0rc0/pythonkuma/models.py

@@ -0,0 +1,101 @@
+"""Uptime Kuma models"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from enum import StrEnum
+from typing import Any
+
+from prometheus_client.parser import text_string_to_metric_families as parser
+
+
+class MonitorType(StrEnum):
+    """Monitors type."""
+
+    HTTP = "http"
+    PORT = "port"
+    PING = "ping"
+    KEYWORD = "keyword"
+    DNS = "dns"
+    PUSH = "push"
+    STEAM = "steam"
+    MQTT = "mqtt"
+    SQL = "sqlserver"
+    JSON_QUERY = "json-query"
+    GROUP = "group"
+    DOCKER = "docker"
+    GRPC_KEYWORD = "grpc-keyword"
+    REAL_BROWSER = "real-browser"
+    GAMEDIG = "gamedig"
+    KAFKA_PRODUCER = "kafka-producer"
+    POSTGRES = "postgres"
+    MYSQL = "mysql"
+    MONGODB = "mongodb"
+    RADIUS = "radius"
+    REDIS = "redis"
+    TAILSCALE_PING = "tailscale-ping"
+
+
+class UptimeKumaBaseModel:
+    """UptimeKumaBaseModel."""
+
+
+@dataclass
+class UptimeKumaMonitor(UptimeKumaBaseModel):
+    """Monitor model for Uptime Kuma."""
+
+    monitor_cert_days_remaining: float = 0
+    monitor_cert_is_valid: float = 0
+    monitor_hostname: str = ""
+    monitor_name: str = ""
+    monitor_port: str = ""
+    monitor_response_time: float = 0
+    monitor_status: float = 0
+    monitor_type: MonitorType = MonitorType.HTTP
+    monitor_url: str = ""
+
+    @staticmethod
+    def from_dict(data: dict[str, Any]) -> UptimeKumaMonitor:
+        """Generate object from json."""
+        obj: dict[str, Any] = {}
+        for key, value in data.items():
+            if hasattr(UptimeKumaMonitor, key):
+                obj[key] = MonitorType(value) if key == "monitor_type" else value
+
+        return UptimeKumaMonitor(**obj)
+
+
+@dataclass
+class UptimeKumaApiResponse(UptimeKumaBaseModel):
+    """API response model for Uptime Kuma."""
+
+    _method: str | None = None
+    _api_path: str | None = None
+    data: list[UptimeKumaMonitor] | None = None
+
+    @staticmethod
+    def from_prometheus(data: dict[str, Any]) -> UptimeKumaApiResponse:
+        """Generate object from json."""
+        obj: dict[str, Any] = {}
+        monitors = []
+
+        for key, value in data.items():
+            if hasattr(UptimeKumaApiResponse, key):
+                obj[key] = value
+
+        parsed = parser(data["monitors"])
+        for family in parsed:
+            for sample in family.samples:
+                if sample.name.startswith("monitor"):
+                    existed = next(
+                        (i for i, x in enumerate(monitors) if x["monitor_name"] == sample.labels["monitor_name"]),
+                        None,
+                    )
+                    if existed is None:
+                        temp = {**sample.labels, sample.name: sample.value}
+                        monitors.append(temp)
+                    else:
+                        monitors[existed][sample.name] = sample.value
+        obj["data"] = [UptimeKumaMonitor.from_dict(monitor) for monitor in monitors]
+
+        return UptimeKumaApiResponse(**obj)

pythonkuma-0.0.0rc0/pythonkuma/uptimekuma.py

@@ -0,0 +1,22 @@
+"""Uptime Kuma client."""
+
+from aiohttp import ClientSession
+
+from .decorator import api_request
+from .models import UptimeKumaApiResponse
+
+
+class UptimeKuma:
+    """This class is used to get information from Uptime Kuma."""
+
+    def __init__(self, session: ClientSession, base_url: str, username: str, password: str) -> None:
+        """Initialize"""
+        self.monitors = []
+        self._base_url = base_url
+        self._username = username
+        self._password = password
+        self._session: ClientSession = session
+
+    @api_request("/metrics")
+    async def async_get_monitors(self, **kwargs) -> UptimeKumaApiResponse:
+        """Get monitors from API."""