pythonkuma 0.1.0__tar.gz → 0.2.0__tar.gz

{pythonkuma-0.1.0 → pythonkuma-0.2.0}/PKG-INFO

@@ -1,8 +1,9 @@
 Metadata-Version: 2.4
 Name: pythonkuma
-Version: 0.1.0
+Version: 0.2.0
 Summary: Simple Python wrapper for Uptime Kuma
 Project-URL: Source, https://github.com/tr4nt0r/pythonkuma
+Project-URL: Documentation, https://tr4nt0r.github.io/pythonkuma
 Author-email: Manfred Dennerlein Rodelo <manfred@dennerlein.name>, Jayakorn Karikan <jayakornk@gmail.com>
 License-Expression: MIT
 License-File: LICENSE
@@ -15,6 +16,8 @@ Requires-Dist: prometheus-client>=0.21.0
 Provides-Extra: dev
 Requires-Dist: aiohttp==3.12.12; extra == 'dev'
 Requires-Dist: mashumaro==3.16; extra == 'dev'
+Requires-Dist: mkdocs-material==9.6.14; extra == 'dev'
+Requires-Dist: mkdocstrings[python]==0.29.1; extra == 'dev'
 Requires-Dist: prometheus-client==0.22.1; extra == 'dev'
 Requires-Dist: ruff==0.11.13; extra == 'dev'
 Description-Content-Type: text/markdown

{pythonkuma-0.1.0 → pythonkuma-0.2.0}/pyproject.toml

@@ -29,10 +29,13 @@ dev = [
     "aiohttp==3.12.12",
     "prometheus-client==0.22.1",
     "mashumaro==3.16",
+    "mkdocs-material==9.6.14",
+    "mkdocstrings[python]==0.29.1",
 ]
 
 [project.urls]
 Source = "https://github.com/tr4nt0r/pythonkuma"
+Documentation = "https://tr4nt0r.github.io/pythonkuma"
 
 [tool.hatch.version]
 source = "regex_commit"
@@ -66,4 +69,8 @@ pythonpath = ["pythonkuma"]
 extra-dependencies = [
     "pythonkuma[dev]",
     "pytest-cov==6.1.1",
-]
+]
+
+[tool.hatch.envs.default.scripts]
+docs-serve = "mkdocs serve"
+docs-build = "mkdocs build"

{pythonkuma-0.1.0 → pythonkuma-0.2.0}/pythonkuma/__init__.py

@@ -5,10 +5,10 @@ from .exceptions import (
     UptimeKumaConnectionException,
     UptimeKumaException,
 )
-from .models import MonitorStatus, MonitorType, UptimeKumaMonitor
+from .models import MonitorStatus, MonitorType, UptimeKumaMonitor, UptimeKumaVersion
 from .uptimekuma import UptimeKuma
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"
 
 __all__ = [
     "MonitorStatus",
@@ -18,4 +18,5 @@ __all__ = [
     "UptimeKumaConnectionException",
     "UptimeKumaException",
     "UptimeKumaMonitor",
+    "UptimeKumaVersion",
 ]

{pythonkuma-0.1.0 → pythonkuma-0.2.0}/pythonkuma/models.py

@@ -43,6 +43,9 @@ class MonitorType(StrEnum):
     RADIUS = "radius"
     REDIS = "redis"
     TAILSCALE_PING = "tailscale-ping"
+    SMTP = "smtp"
+    SNMP = "snmp"
+    RABBIT_MQ = "rabbitmq"
     UNKNOWN = "unknown"
 
     @classmethod
@@ -60,8 +63,9 @@ class UptimeKumaBaseModel(DataClassDictMixin):
 class UptimeKumaMonitor(UptimeKumaBaseModel):
     """Monitor model for Uptime Kuma."""
 
-    monitor_cert_days_remaining: int
-    monitor_cert_is_valid: bool
+    monitor_id: int | None = None
+    monitor_cert_days_remaining: int | None = None
+    monitor_cert_is_valid: bool | None = None
     monitor_hostname: str | None = field(
         metadata={"deserialize": lambda v: None if v == "null" else v}
     )
@@ -75,3 +79,13 @@ class UptimeKumaMonitor(UptimeKumaBaseModel):
     monitor_url: str | None = field(
         metadata={"deserialize": lambda v: None if v == "null" else v}
     )
+
+
+@dataclass
+class UptimeKumaVersion(UptimeKumaBaseModel):
+    """Uptime Kuma version."""
+
+    version: str = ""
+    major: str = ""
+    minor: str = ""
+    patch: str = ""

{pythonkuma-0.1.0 → pythonkuma-0.2.0}/pythonkuma/uptimekuma.py

@@ -14,7 +14,7 @@ from prometheus_client.parser import text_string_to_metric_families
 from yarl import URL
 
 from .exceptions import UptimeKumaAuthenticationException, UptimeKumaConnectionException
-from .models import UptimeKumaMonitor
+from .models import UptimeKumaMonitor, UptimeKumaVersion
 
 
 class UptimeKuma:
@@ -27,7 +27,19 @@ class UptimeKuma:
         api_key: str | None = None,
         timeout: float | None = None,
     ) -> None:
-        """Initialize the Uptime Kuma client."""
+        """Initialize the Uptime Kuma client.
+
+        Parameters
+        ----------
+        session : ClientSession
+            An aiohttp ClientSession instance
+        base_url : URL or str
+            The base URL of the Uptime Kuma server
+        api_key : str or None, optional
+            API key for authentication (default is None).
+        timeout : float or None, optional
+            Request timeout in seconds (default is 10 seconds if not specified).
+        """
         self._base_url = base_url if isinstance(base_url, URL) else URL(base_url)
 
         self._auth = BasicAuth("", api_key) if api_key else None
@@ -35,8 +47,30 @@ class UptimeKuma:
         self._timeout = ClientTimeout(total=timeout or 10)
         self._session = session
 
-    async def metrics(self) -> dict[str, UptimeKumaMonitor]:
-        """Retrieve metrics from Uptime Kuma."""
+        self.version = UptimeKumaVersion()
+
+    async def metrics(self) -> dict[str | int, UptimeKumaMonitor]:
+        """Retrieve metrics from Uptime Kuma.
+
+        Fetches and parses Prometheus-style metrics from the Uptime Kuma API endpoint,
+        extracting monitor-related metrics and returning them as a dictionary of
+        UptimeKumaMonitor objects keyed by monitor name.
+
+        Returns
+        -------
+        dict[str, UptimeKumaMonitor]
+            A dictionary mapping monitor names to their corresponding UptimeKumaMonitor
+            objects.
+
+        Raises
+        ------
+        UptimeKumaAuthenticationException
+            If authentication with the Uptime Kuma API fails.
+        UptimeKumaConnectionException
+            If there is a connection error, timeout, or other client error during the
+            request.
+        """
+        monitors: dict[str | int, dict[str, Any]] = {}
         url = self._base_url / "metrics"
 
         try:
@@ -56,17 +90,19 @@ class UptimeKuma:
         except ClientError as e:
             raise UptimeKumaConnectionException from e
         else:
-            parsed = text_string_to_metric_families(await request.text())
-
-            monitors: dict[str, dict[str, Any]] = {}
-            for metric in parsed:
+            for metric in text_string_to_metric_families(await request.text()):
+                if metric.name == "app_version" and metric.samples:
+                    self.version = UptimeKumaVersion.from_dict(metric.samples[0].labels)
                 if not metric.name.startswith("monitor"):
                     continue
                 for sample in metric.samples:
-                    if not (monitor_name := sample.labels.get("monitor_name")):
-                        continue
+                    key = (
+                        int(monitor_id)
+                        if (monitor_id := sample.labels.get("monitor_id"))
+                        else sample.labels["monitor_name"]
+                    )
 
-                    monitors.setdefault(monitor_name, sample.labels).update(
+                    monitors.setdefault(key, sample.labels).update(
                         {sample.name: sample.value}
                     )