PyObservability 0.0.0a2__py3-none-any.whl → 0.0.1__py3-none-any.whl

pyobservability/config/enums.py

@@ -0,0 +1,6 @@
+from enum import StrEnum
+
+
+class APIEndpoints(StrEnum):
+    root = "/"
+    ws = "/ws"

pyobservability/config/settings.py

@@ -1,10 +1,12 @@
 import json
+import os
 import pathlib
 import socket
 from typing import List
 
 import yaml
-from pydantic import BaseModel, HttpUrl, PositiveInt
+from pydantic import BaseModel, Field, HttpUrl, PositiveInt
+from pydantic.aliases import AliasChoices
 from pydantic_settings import BaseSettings
 
 
@@ -34,6 +36,19 @@ class MonitorTarget(BaseModel):
     apikey: str
 
 
+def alias_choices(variable: str) -> AliasChoices:
+    """Custom alias choices for environment variables for GitHub.
+
+    Args:
+        variable: Variable name.
+
+    Returns:
+        AliasChoices:
+        Returns the alias choices for the variable.
+    """
+    return AliasChoices(variable, f"MONITOR_{variable}")
+
+
 class EnvConfig(PydanticEnvConfig):
     """Configuration settings for the server.
 
@@ -41,11 +56,14 @@ class EnvConfig(PydanticEnvConfig):
 
     """
 
-    host: str = socket.gethostbyname("localhost") or "0.0.0.0"
-    port: PositiveInt = 8080
+    host: str = Field(socket.gethostbyname("localhost") or "0.0.0.0", validation_alias=alias_choices("HOST"))
+    port: PositiveInt = Field(8080, validation_alias=alias_choices("PORT"))
+
+    targets: List[MonitorTarget] = Field(..., validation_alias=alias_choices("TARGETS"))
+    interval: PositiveInt = Field(3, validation_alias=alias_choices("INTERVAL"))
 
-    monitor_targets: List[MonitorTarget]
-    poll_interval: PositiveInt = 3
+    username: str | None = Field(None, validation_alias=alias_choices("USERNAME"))
+    password: str | None = Field(None, validation_alias=alias_choices("PASSWORD"))
 
     class Config:
         """Environment variables configuration."""
@@ -79,28 +97,27 @@ def env_loader(**kwargs) -> EnvConfig:
     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"):
+    if env_file := kwargs.get("env_file") or os.getenv("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"):
+        if 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 (
+        if 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)"
-            )
+        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)
 

pyobservability/main.py

@@ -1,13 +1,15 @@
 import logging
 import pathlib
+import warnings
 
+import uiauth
 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.config import enums, settings
 from pyobservability.monitor import Monitor
 
 LOGGER = logging.getLogger("uvicorn.default")
@@ -59,20 +61,41 @@ async def websocket_endpoint(websocket: WebSocket):
     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 include_routes():
+    if all((settings.env.username, settings.env.password)):
+        uiauth.protect(
+            app=PyObservability,
+            username=settings.env.username,
+            password=settings.env.password,
+            params=[
+                uiauth.Parameters(
+                    path=enums.APIEndpoints.root,
+                    function=index,
+                    methods=["GET"],
+                ),
+                uiauth.Parameters(
+                    path=enums.APIEndpoints.ws,
+                    function=websocket_endpoint,
+                    route=APIWebSocketRoute,
+                ),
+            ],
+        )
+    else:
+        warnings.warn("\n\tRunning PyObservability without any protection.", UserWarning)
+        PyObservability.routes.append(
+            APIRoute(
+                path=enums.APIEndpoints.root,
+                endpoint=index,
+                methods=["GET"],
+                include_in_schema=False,
+            ),
+        )
+        PyObservability.routes.append(
+            APIWebSocketRoute(
+                path=enums.APIEndpoints.ws,
+                endpoint=websocket_endpoint,
+            )
+        )
 
 
 def start(**kwargs):
@@ -80,6 +103,7 @@ def start(**kwargs):
     settings.env.monitor_targets = [
         {k: str(v) for k, v in target.model_dump().items()} for target in settings.env.monitor_targets
     ]
+    include_routes()
     uvicorn_args = dict(
         host=settings.env.host,
         port=settings.env.port,

pyobservability/version.py

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

pyobservability-0.0.1.dist-info/METADATA

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: PyObservability
+Version: 0.0.1
+Summary: Lightweight OS-agnostic observability UI for PyNinja
+Author-email: Vignesh Rao <svignesh1793@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 TheVickypedia
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/thevickypedia/PyObservability
+Project-URL: Docs, https://thevickypedia.github.io/PyObservability
+Project-URL: Source, https://github.com/thevickypedia/PyObservability
+Project-URL: Bug Tracker, https://github.com/thevickypedia/PyObservability/issues
+Project-URL: Release Notes, https://github.com/thevickypedia/PyObservability/blob/main/release_notes.rst
+Keywords: PyObservability,observability,system-monitor,PyNinja
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Development Status :: 3 - Alpha
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp==3.13.*
+Requires-Dist: fastapi==0.122.*
+Requires-Dist: FastAPI-UI-Auth==0.2.1
+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"
+Requires-Dist: recommonmark; extra == "dev"
+Requires-Dist: gitverse; extra == "dev"
+Dynamic: license-file
+
+# PyObservability
+
+![Python][label-pyversion]
+
+**Platform Supported**
+
+![Platform][label-platform]
+
+**Deployments**
+
+[![pypi][label-actions-pypi]][gha_pypi]
+[![notes][label-actions-notes]][gha_notes]
+[![release][label-actions-release]][gha_release]
+
+[![Pypi][label-pypi]][pypi]
+[![Pypi-format][label-pypi-format]][pypi-files]
+[![Pypi-status][label-pypi-status]][pypi]
+
+## Kick off
+
+**Recommendations**
+
+- Install `python` [3.11] or above
+- Use a dedicated [virtual environment]
+
+**Install PyObservability**
+```shell
+python -m pip install pyobservability
+```
+
+**Initiate - IDE**
+```python
+import pyobservability
+
+
+if __name__ == '__main__':
+    pyobservability.start()
+```
+
+**Initiate - CLI**
+```shell
+pyobservability start
+```
+
+> Use `pyobservability --help` for usage instructions.
+
+## Environment Variables
+
+<details>
+<summary><strong>Sourcing environment variables from an env file</strong></summary>
+
+> _By default, `PyObservability` will look for a `.env` file in the current working directory._
+> _Other file options are supported with a custom kwarg or env var `env_file` pointing to the filepath._
+</details>
+
+**Mandatory**
+- **TARGETS** - Target URLs running `PyNinja` in the following format.
+    - `TARGETS='[{"name":"node1","base_url":"http://192.168.1.10:8000","apikey":"token1"},{"name":"node2","base_url":"http://192.168.1.11:8000"}]'`
+
+**Defaults**
+- **HOST** - Host IP to run PyObservability. Defaults to `127.0.0.1` or `0.0.0.0`
+- **PORT** - Port number to run PyObservability. Defaults to `8080`
+- **INTERVAL** - Polling interval to retrieve server information.
+
+**Optional**
+- **USERNAME** - Username to authenticate the monitoring page.
+- **PASSWORD** - Password to authenticate the monitoring page.
+
+## License & copyright
+
+&copy; Vignesh Rao
+
+Licensed under the [MIT License][license]
+
+[//]: # (Labels)
+
+[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-pyobservability-blue?style=for-the-badge&logo=Python
+[label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx
+[label-pyversion]: https://img.shields.io/badge/python-3.11%20%7C%203.12-blue
+[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg
+[label-actions-pypi]: https://github.com/thevickypedia/PyObservability/actions/workflows/python-publish.yml/badge.svg
+[label-pypi]: https://img.shields.io/pypi/v/PyObservability
+[label-pypi-format]: https://img.shields.io/pypi/format/PyObservability
+[label-pypi-status]: https://img.shields.io/pypi/status/PyObservability
+[label-actions-notes]: https://github.com/thevickypedia/PyObservability/actions/workflows/notes.yml/badge.svg
+[label-actions-release]: https://github.com/thevickypedia/PyObservability/actions/workflows/release.yml/badge.svg
+
+[3.11]: https://docs.python.org/3/whatsnew/3.11.html
+[virtual environment]: https://docs.python.org/3/tutorial/venv.html
+[release-notes]: https://github.com/thevickypedia/PyObservability/blob/main/release_notes.rst
+[gha_pypi]: https://github.com/thevickypedia/PyObservability/actions/workflows/python-publish.yml
+[gha_notes]: https://github.com/thevickypedia/PyObservability/actions/workflows/notes.yml
+[gha_release]: https://github.com/thevickypedia/PyObservability/actions/workflows/release.yml
+[google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
+[pep8]: https://www.python.org/dev/peps/pep-0008/
+[isort]: https://pycqa.github.io/isort/
+[sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
+[pypi]: https://pypi.org/project/PyObservability
+[pypi-files]: https://pypi.org/project/PyObservability/#files
+[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
+[license]: https://github.com/thevickypedia/PyObservability/blob/main/LICENSE
+[runbook]: https://thevickypedia.github.io/PyObservability/
+[samples]: https://github.com/thevickypedia/PyObservability/tree/main/samples
+[PyUdisk]: https://github.com/thevickypedia/PyUdisk
+[PyArchitecture]: https://github.com/thevickypedia/PyArchitecture

pyobservability-0.0.1.dist-info/RECORD

@@ -0,0 +1,15 @@
+pyobservability/__init__.py,sha256=rr4udGMbbNPl3yo7l8R3FUUVVahBtYVaW6vSWWgXlv0,2617
+pyobservability/main.py,sha256=5_c4Q2D5EgUTQgs6kULBpn0O8dF_k7LacdQhPq1qHnk,3451
+pyobservability/monitor.py,sha256=s2sVp97sLjkkdtL6be82bX5ydu_gBdMSoWxDlmUtpgE,6613
+pyobservability/version.py,sha256=sXLh7g3KC4QCFxcZGBTpG2scR7hmmBsMjq6LqRptkRg,22
+pyobservability/config/enums.py,sha256=iMIOpa8LYSszkPIYBhupX--KrEXVTTsBurinpAxLvMA,86
+pyobservability/config/settings.py,sha256=3nPvA-GsmtunUIGcroHqwgSvQ24TmIdINs-QRD_dg2s,3737
+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.1.dist-info/licenses/LICENSE,sha256=_sOIKJWdD2o1WwwDIwYB2qTP2nlSWqT5Tyg9jr1Xa4w,1070
+pyobservability-0.0.1.dist-info/METADATA,sha256=BQ4Z6EbkaRWOaY1oc4rf3wpulGoYtUhIfEPDBdCDYBU,6822
+pyobservability-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pyobservability-0.0.1.dist-info/entry_points.txt,sha256=DSGIr_VA8Tb3FYa2iNUYpf55eAvuFCAoInNS4ngXaME,57
+pyobservability-0.0.1.dist-info/top_level.txt,sha256=p20T0EmihDYW1uMintRXr7X9bg3XWYKyoSbBHOVC1xI,16
+pyobservability-0.0.1.dist-info/RECORD,,

pyobservability-0.0.0a2.dist-info/METADATA

@@ -1,58 +0,0 @@
-Metadata-Version: 2.4
-Name: PyObservability
-Version: 0.0.0a2
-Summary: Lightweight OS-agnostic observability UI for PyNinja
-Author-email: Vignesh Rao <svignesh1793@gmail.com>
-License: MIT License
-        
-        Copyright (c) 2025 TheVickypedia
-        
-        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.
-        
-Project-URL: Homepage, https://github.com/thevickypedia/PyObservability
-Project-URL: Docs, https://thevickypedia.github.io/PyObservability
-Project-URL: Source, https://github.com/thevickypedia/PyObservability
-Project-URL: Bug Tracker, https://github.com/thevickypedia/PyObservability/issues
-Project-URL: Release Notes, https://github.com/thevickypedia/PyObservability/blob/main/release_notes.rst
-Keywords: PyObservability,observability,system-monitor,PyNinja
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Development Status :: 3 - Alpha
-Classifier: Operating System :: MacOS :: MacOS X
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Topic :: System :: Monitoring
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-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"
-Requires-Dist: recommonmark; extra == "dev"
-Requires-Dist: gitverse; extra == "dev"
-Dynamic: license-file
-
-# PyObservability

pyobservability-0.0.0a2.dist-info/RECORD

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