PyObservability 0.0.0a1__py3-none-any.whl → 0.0.0a2__py3-none-any.whl

pyobservability/__init__.py

@@ -0,0 +1,68 @@
+"""Module for packaging."""
+
+import sys
+
+from pyobservability.main import start  # noqa: F401
+from pyobservability.version import __version__
+
+
+def _cli() -> None:
+    """Starter function to invoke the observability UI via CLI commands.
+
+    **Flags**
+        - ``--version | -V``: Prints the version.
+        - ``--help | -H``: Prints the help section.
+        - ``--env | -E <path>``: Filepath to load environment variables.
+
+    **Commands**
+        ``start``: Initiates the PyObservability as a regular script.
+    """
+    assert sys.argv[0].endswith("pyobservability"), "Invalid commandline trigger!!"
+    options = {
+        "--version | -V": "Prints the version.",
+        "--help | -H": "Prints the help section.",
+        "--env | -E <path>": "Filepath to load environment variables.",
+        "start": "Initiates the PyObservability as a regular script.",
+    }
+    # weird way to increase spacing to keep all values monotonic
+    _longest_key = len(max(options.keys()))
+    _pretext = "\n\t* "
+    choices = _pretext + _pretext.join(
+        f"{k} {'·' * (_longest_key - len(k) + 8)}→ {v}".expandtabs() for k, v in options.items()
+    )
+    args = [arg.lower() for arg in sys.argv[1:]]
+    try:
+        assert len(args) > 1
+    except (IndexError, AttributeError, AssertionError):
+        print(f"Cannot proceed without a valid arbitrary command. Please choose from {choices}")
+        exit(1)
+    env_file = None
+    if any(arg in args for arg in ["version", "--version", "-v"]):
+        print(f"PyObservability: {__version__}")
+        exit(0)
+    elif any(arg in args for arg in ["help", "--help", "-h"]):
+        print(f"Usage: pyobservability [arbitrary-command]\nOptions (and corresponding behavior):{choices}")
+        exit(0)
+    elif any(arg in args for arg in ["env", "--env", "E", "-e"]):
+        extra_index = next(
+            (index for index, arg in enumerate(args) if arg in ["env", "--env", "E", "-e"]),
+            None,
+        )
+        try:
+            env_file = sys.argv[extra_index + 2]
+        except (IndexError, TypeError):
+            print("Cannot proceed without a valid extra environment file path.")
+            exit(1)
+    elif any(arg in args for arg in ("start",)):
+        pass
+    else:
+        print(f"Unknown Option: {sys.argv[1]}\nArbitrary commands must be one of {choices}")
+        exit(1)
+    if any(arg in args for arg in ("start",)):
+        start(env_file=env_file)
+    else:
+        print(
+            "Insufficient Arguments:\n\tNo command received to initiate the PyObservability. "
+            f"Please choose from {choices}"
+        )
+        exit(1)

pyobservability/config/settings.py

@@ -0,0 +1,108 @@
+import json
+import pathlib
+import socket
+from typing import List
+
+import yaml
+from pydantic import BaseModel, HttpUrl, PositiveInt
+from pydantic_settings import BaseSettings
+
+
+class PydanticEnvConfig(BaseSettings):
+    """Pydantic BaseSettings with custom order for loading environment variables.
+
+    >>> PydanticEnvConfig
+
+    """
+
+    @classmethod
+    def settings_customise_sources(
+        cls,
+        settings_cls,
+        init_settings,
+        env_settings,
+        dotenv_settings,
+        file_secret_settings,
+    ):
+        """Order: dotenv, env, init, secrets files."""
+        return dotenv_settings, env_settings, init_settings, file_secret_settings
+
+
+class MonitorTarget(BaseModel):
+    name: str
+    base_url: HttpUrl
+    apikey: str
+
+
+class EnvConfig(PydanticEnvConfig):
+    """Configuration settings for the server.
+
+    >>> EnvConfig
+
+    """
+
+    host: str = socket.gethostbyname("localhost") or "0.0.0.0"
+    port: PositiveInt = 8080
+
+    monitor_targets: List[MonitorTarget]
+    poll_interval: PositiveInt = 3
+
+    class Config:
+        """Environment variables configuration."""
+
+        env_prefix = ""
+        extra = "forbid"
+
+    @classmethod
+    def from_env_file(cls, filename: pathlib.Path) -> "EnvConfig":
+        """Create an instance of EnvConfig from environment file.
+
+        Args:
+            filename: Name of the env file.
+
+        Returns:
+            EnvConfig:
+            Loads the ``EnvConfig`` model.
+        """
+        # noinspection PyArgumentList
+        return cls(_env_file=filename)
+
+
+def env_loader(**kwargs) -> EnvConfig:
+    """Loads environment variables based on filetypes or kwargs.
+
+    Returns:
+        EnvConfig:
+        Returns a reference to the ``EnvConfig`` object.
+    """
+    # Default to .env if no kwargs were passed
+    if not kwargs:
+        return EnvConfig.from_env_file(".env")
+    # Look for the kwarg env_file and process accordingly
+    if env_file := kwargs.get("env_file"):
+        env_file = pathlib.Path(env_file)
+        assert env_file.is_file(), f"\n\tenv_file: [{env_file.resolve()!r}] does not exist"
+        if env_file.suffix.lower() == ".json":
+            with env_file.open() as stream:
+                env_data = json.load(stream)
+            return EnvConfig(**{k.lower(): v for k, v in env_data.items()})
+        elif env_file.suffix.lower() in (".yaml", ".yml"):
+            with env_file.open() as stream:
+                env_data = yaml.load(stream, yaml.FullLoader)
+            return EnvConfig(**{k.lower(): v for k, v in env_data.items()})
+        elif not env_file.suffix or env_file.suffix.lower() in (
+            ".text",
+            ".txt",
+            ".env",
+            "",
+        ):
+            return EnvConfig.from_env_file(env_file)
+        else:
+            raise ValueError(
+                f"\n\tUnsupported format for {env_file!r}, " "can be one of (.json, .yaml, .yml, .txt, .text, .env)"
+            )
+    # Load env config with regular kwargs
+    return EnvConfig(**kwargs)
+
+
+env: EnvConfig

pyobservability/main.py

@@ -1,45 +1,45 @@
 import logging
-import os
 import pathlib
 
-import dotenv
+import uvicorn
 from fastapi import FastAPI, Request, WebSocket, WebSocketDisconnect
+from fastapi.routing import APIRoute, APIWebSocketRoute
 from fastapi.staticfiles import StaticFiles
 from fastapi.templating import Jinja2Templates
 
+from pyobservability.config import settings
 from pyobservability.monitor import Monitor
 
-dotenv.load_dotenv()
-
 LOGGER = logging.getLogger("uvicorn.default")
 
-app = FastAPI(title="Monitor UI")
+PyObservability = FastAPI(title="PyObservability")
+PyObservability.__name__ = "PyObservability"
+PyObservability.description = "Observability page for nodes running PyNinja"
+
 root = pathlib.Path(__file__).parent
 templates_dir = root / "templates"
-static_dir = root / "static"
 templates = Jinja2Templates(directory=templates_dir)
-app.mount("/static", StaticFiles(directory=static_dir), name="static")
 
-monitor = Monitor(poll_interval=float(os.getenv("POLL_INTERVAL", 2)))
+static_dir = root / "static"
+PyObservability.mount("/static", StaticFiles(directory=static_dir), name="static")
 
 
-@app.get("/")
 async def index(request: Request):
     """Pass configured targets to the template so frontend can prebuild UI.
 
     Args:
         request: FastAPI request object.
     """
-    return templates.TemplateResponse("index.html", {"request": request, "targets": monitor.targets})
+    return templates.TemplateResponse("index.html", {"request": request, "targets": settings.env.monitor_targets})
 
 
-@app.websocket("/ws")
 async def websocket_endpoint(websocket: WebSocket):
     """Websocket endpoint to render the metrics.
 
     Args:
         websocket: FastAPI websocket object.
     """
+    monitor = Monitor(targets=settings.env.monitor_targets, poll_interval=settings.env.poll_interval)
     await websocket.accept()
     await monitor.start()
     q = monitor.subscribe()
@@ -56,5 +56,33 @@ async def websocket_endpoint(websocket: WebSocket):
             await websocket.close()
         except Exception as err:
             LOGGER.warning(err)
-            pass
     await monitor.stop()
+
+
+PyObservability.routes.append(
+    APIRoute(
+        path="/",  # enums.APIEndpoints.root,
+        endpoint=index,
+        methods=["GET"],
+        include_in_schema=False,
+    ),
+)
+PyObservability.routes.append(
+    APIWebSocketRoute(
+        path="/ws",
+        endpoint=websocket_endpoint,
+    )
+)
+
+
+def start(**kwargs):
+    settings.env = settings.env_loader(**kwargs)
+    settings.env.monitor_targets = [
+        {k: str(v) for k, v in target.model_dump().items()} for target in settings.env.monitor_targets
+    ]
+    uvicorn_args = dict(
+        host=settings.env.host,
+        port=settings.env.port,
+        app=PyObservability,
+    )
+    uvicorn.run(**uvicorn_args)

pyobservability/monitor.py

@@ -1,9 +1,7 @@
 # app/monitor.py
 
 import asyncio
-import json
 import logging
-import os
 from asyncio import CancelledError
 from typing import Any, Dict, List
 from urllib.parse import urlparse
@@ -60,42 +58,6 @@ ENDPOINTS = {
 }
 
 
-###############################################################################
-# LOAD TARGETS FROM ENV
-###############################################################################
-
-
-def load_targets_from_env() -> List[Dict[str, Any]]:
-    """Loads monitor targets from environment variables and parses it.
-
-    Returns:
-        List[Dict[str, Any]]:
-        Returns the parsed list of the monitor targets.
-    """
-    raw = os.getenv("MONITOR_TARGETS", "[]")
-
-    try:
-        data = json.loads(raw)
-    except Exception:
-        data = [raw] if raw else []
-
-    parsed = []
-
-    for entry in data:
-        if isinstance(entry, str):
-            parsed.append({"name": entry, "base_url": entry, "apikey": None})
-        elif isinstance(entry, dict):
-            parsed.append(
-                {
-                    "name": entry.get("name") or entry["base_url"],
-                    "base_url": entry["base_url"],
-                    "apikey": entry.get("apikey"),
-                }
-            )
-
-    return parsed
-
-
 ###############################################################################
 # MONITOR CLASS
 ###############################################################################
@@ -103,9 +65,9 @@ def load_targets_from_env() -> List[Dict[str, Any]]:
 
 class Monitor:
 
-    def __init__(self, poll_interval: float = 2.0):
-        self.targets = load_targets_from_env()
-        self.poll_interval = float(os.getenv("POLL_INTERVAL", poll_interval))
+    def __init__(self, targets: List[Dict[str, str]], poll_interval: float):
+        self.targets = targets
+        self.poll_interval = poll_interval
         self.sessions: Dict[str, aiohttp.ClientSession] = {}
         self._ws_subscribers: List[asyncio.Queue] = []
         self._task = None
@@ -115,8 +77,8 @@ class Monitor:
     # LIFECYCLE
     ############################################################################
     async def start(self):
-        for t in self.targets:
-            self.sessions[t["base_url"]] = aiohttp.ClientSession()
+        for target in self.targets:
+            self.sessions[target["base_url"]] = aiohttp.ClientSession()
         self._task = asyncio.create_task(self._run_loop())
 
     async def stop(self):
@@ -148,12 +110,8 @@ class Monitor:
     ############################################################################
     # FETCH WRAPPER
     ############################################################################
-    async def _fetch(self, session, base_url, ep, apikey=None, params=None):
+    async def _fetch(self, session, base_url, ep, headers: Dict[str, str], params=None):
         url = base_url.rstrip("/") + ep
-        headers = {"accept": "application/json"}
-        if apikey:
-            headers["Authorization"] = f"Bearer {apikey}"
-
         try:
             async with session.get(url, headers=headers, params=params, timeout=10) as resp:
                 if resp.status == 200:
@@ -174,8 +132,9 @@ class Monitor:
     ############################################################################
     async def _poll_target(self, target: Dict[str, Any]) -> Dict[str, Any]:
         base = target["base_url"]
-        apikey = target.get("apikey")
+        apikey = target["apikey"]
         session = self.sessions[base]
+        headers = {"Accept": "application/json", "Authorization": f"Bearer {apikey}"}
 
         result = {"name": target["name"], "base_url": base, "metrics": {}}
 
@@ -184,7 +143,7 @@ class Monitor:
 
         for key, cfg in ENDPOINTS.items():
             tasks[key] = asyncio.create_task(
-                self._fetch(session, base, cfg["path"], apikey=apikey, params=cfg["params"])
+                self._fetch(session, base, cfg["path"], headers=headers, params=cfg["params"])
             )
 
         # Wait for all endpoints
@@ -206,7 +165,7 @@ class Monitor:
     # POLL ALL HOSTS
     ############################################################################
     async def _poll_all(self) -> List[Dict[str, Any]]:
-        tasks = [self._poll_target(t) for t in self.targets]
+        tasks = [self._poll_target(target) for target in self.targets]
         results = await asyncio.gather(*tasks, return_exceptions=True)
         out = []
         for r in results:

pyobservability/version.py

@@ -1 +1 @@
-__version__ = "0.0.0a1"
+__version__ = "0.0.0a2"

{pyobservability-0.0.0a1.dist-info → pyobservability-0.0.0a2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyObservability
-Version: 0.0.0a1
+Version: 0.0.0a2
 Summary: Lightweight OS-agnostic observability UI for PyNinja
 Author-email: Vignesh Rao <svignesh1793@gmail.com>
 License: MIT License
@@ -41,11 +41,13 @@ Classifier: Topic :: System :: Monitoring
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp
-Requires-Dist: fastapi
-Requires-Dist: jinja2
-Requires-Dist: python-dotenv
-Requires-Dist: uvicorn[standard]
+Requires-Dist: aiohttp==3.13.*
+Requires-Dist: fastapi==0.122.*
+Requires-Dist: Jinja2==3.1.*
+Requires-Dist: pydantic==2.12.*
+Requires-Dist: pydantic-settings==2.12.*
+Requires-Dist: python-dotenv==1.2.*
+Requires-Dist: uvicorn[standard]==0.38.*
 Provides-Extra: dev
 Requires-Dist: sphinx==5.1.1; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"

pyobservability-0.0.0a2.dist-info/RECORD

@@ -0,0 +1,14 @@
+pyobservability/__init__.py,sha256=rr4udGMbbNPl3yo7l8R3FUUVVahBtYVaW6vSWWgXlv0,2617
+pyobservability/main.py,sha256=m3jNBQ7B495d1Pk_Fcdy3AQbNts2K8iFwDQDKV1pB0M,2527
+pyobservability/monitor.py,sha256=s2sVp97sLjkkdtL6be82bX5ydu_gBdMSoWxDlmUtpgE,6613
+pyobservability/version.py,sha256=za-UuO_D1PzxYCprpyh75AnwaFhntPuAZpHRqS1fIxc,24
+pyobservability/config/settings.py,sha256=53dYdfO5SbmHQ4cLzPM2JQvrU2Lw70vBghlhiLy28ZI,3013
+pyobservability/static/app.js,sha256=poc7eReoiRUbyI5JKnPwxSqmSNCuOge4aZKCITFy7eo,13494
+pyobservability/static/styles.css,sha256=t6r1C0ueBanipgRRjdu18nmq6RbSGLK5bhpf0BdMOpQ,3245
+pyobservability/templates/index.html,sha256=PsN3aq-7Q6RzGeshoNH5v37G3sHoI2saJq6mfuA6JYs,3977
+pyobservability-0.0.0a2.dist-info/licenses/LICENSE,sha256=_sOIKJWdD2o1WwwDIwYB2qTP2nlSWqT5Tyg9jr1Xa4w,1070
+pyobservability-0.0.0a2.dist-info/METADATA,sha256=y74dxaDkt1pTwgqFmkNj7bemJqOPqKUjfHBHPwWh0UA,2775
+pyobservability-0.0.0a2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pyobservability-0.0.0a2.dist-info/entry_points.txt,sha256=DSGIr_VA8Tb3FYa2iNUYpf55eAvuFCAoInNS4ngXaME,57
+pyobservability-0.0.0a2.dist-info/top_level.txt,sha256=p20T0EmihDYW1uMintRXr7X9bg3XWYKyoSbBHOVC1xI,16
+pyobservability-0.0.0a2.dist-info/RECORD,,

pyobservability-0.0.0a2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pyobservability = pyobservability:_cli

pyobservability-0.0.0a1.dist-info/RECORD

@@ -1,12 +0,0 @@
-pyobservability/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pyobservability/main.py,sha256=XzH2XNuxU9lbFSnQXsJqJ2ytrd6nnzbTf7B0n0UQuW0,1637
-pyobservability/monitor.py,sha256=nnL6odqO3BF-XH1wek0leyMKXw7NB8qrwp6aAh-xJyA,7694
-pyobservability/version.py,sha256=PvT0JaYWREcshCnUiHC2CMpUMuTV359GmoET7cuhPiU,24
-pyobservability/static/app.js,sha256=poc7eReoiRUbyI5JKnPwxSqmSNCuOge4aZKCITFy7eo,13494
-pyobservability/static/styles.css,sha256=t6r1C0ueBanipgRRjdu18nmq6RbSGLK5bhpf0BdMOpQ,3245
-pyobservability/templates/index.html,sha256=PsN3aq-7Q6RzGeshoNH5v37G3sHoI2saJq6mfuA6JYs,3977
-pyobservability-0.0.0a1.dist-info/licenses/LICENSE,sha256=_sOIKJWdD2o1WwwDIwYB2qTP2nlSWqT5Tyg9jr1Xa4w,1070
-pyobservability-0.0.0a1.dist-info/METADATA,sha256=Ze1eq09JsbqSTcpPFIrvMQxKJubLqKxzAxcMhLIzbzw,2663
-pyobservability-0.0.0a1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pyobservability-0.0.0a1.dist-info/top_level.txt,sha256=p20T0EmihDYW1uMintRXr7X9bg3XWYKyoSbBHOVC1xI,16
-pyobservability-0.0.0a1.dist-info/RECORD,,