lvqr 0.1.0__tar.gz

lvqr-0.1.0/.gitignore

@@ -0,0 +1,52 @@
+# Rust
+/target/
+**/*.rs.bk
+*.pdb
+
+# WASM
+/pkg/
+crates/lvqr-wasm/pkg/
+bindings/js/packages/*/wasm/
+
+# Node
+node_modules/
+bindings/js/packages/*/dist/
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.whl
+venv/
+.venv/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Environment
+.env
+.env.local
+.env.*.local
+
+# Logs
+*.log
+
+# TLS dev certs (auto-generated)
+*.pem
+!deploy/certs/*.pem
+
+# Coverage
+lcov.info
+tarpaulin-report.html

lvqr-0.1.0/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: lvqr
+Version: 0.1.0
+Summary: LVQR client for Python - Live Video QUIC Relay admin and monitoring
+Project-URL: Repository, https://github.com/virgilvox/lvqr
+Project-URL: Documentation, https://github.com/virgilvox/lvqr/tree/main/bindings/python
+Author-email: Moheeb Zara <hackbuildvideo@gmail.com>
+License: MIT OR Apache-2.0
+Keywords: moq,quic,relay,streaming,video
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Video
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.27
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'

lvqr-0.1.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "lvqr"
+version = "0.1.0"
+description = "LVQR client for Python - Live Video QUIC Relay admin and monitoring"
+license = {text = "MIT OR Apache-2.0"}
+requires-python = ">=3.9"
+authors = [{name = "Moheeb Zara", email = "hackbuildvideo@gmail.com"}]
+keywords = ["streaming", "video", "quic", "moq", "relay"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Topic :: Multimedia :: Video",
+    "Programming Language :: Python :: 3",
+]
+dependencies = [
+    "httpx>=0.27",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=0.23",
+]
+
+[project.urls]
+Repository = "https://github.com/virgilvox/lvqr"
+Documentation = "https://github.com/virgilvox/lvqr/tree/main/bindings/python"
+
+[tool.hatch.build.targets.wheel]
+packages = ["python/lvqr"]

lvqr-0.1.0/python/lvqr/__init__.py

@@ -0,0 +1,8 @@
+"""LVQR - Live Video QUIC Relay Python client."""
+
+__version__ = "0.1.0"
+
+from .client import LvqrClient
+from .types import RelayStats, StreamInfo
+
+__all__ = ["LvqrClient", "RelayStats", "StreamInfo"]

lvqr-0.1.0/python/lvqr/client.py

@@ -0,0 +1,83 @@
+"""LVQR admin API client."""
+
+from __future__ import annotations
+
+import httpx
+
+from .types import RelayStats, StreamInfo
+
+
+class LvqrClient:
+    """Client for the LVQR admin HTTP API.
+
+    Args:
+        base_url: Base URL of the LVQR admin server (e.g., "http://localhost:8080").
+        timeout: Request timeout in seconds.
+
+    Example::
+
+        client = LvqrClient("http://localhost:8080")
+        if client.healthz():
+            stats = client.stats()
+            print(f"Tracks: {stats.tracks}, Subscribers: {stats.subscribers}")
+    """
+
+    def __init__(self, base_url: str, timeout: float = 10.0):
+        self.base_url = base_url.rstrip("/")
+        self._client = httpx.Client(base_url=self.base_url, timeout=timeout)
+
+    def close(self) -> None:
+        """Close the HTTP client."""
+        self._client.close()
+
+    def __enter__(self) -> LvqrClient:
+        return self
+
+    def __exit__(self, *args: object) -> None:
+        self.close()
+
+    def healthz(self) -> bool:
+        """Check if the relay is healthy.
+
+        Returns:
+            True if the server responds with 200 OK.
+        """
+        try:
+            resp = self._client.get("/healthz")
+            return resp.status_code == 200
+        except httpx.HTTPError:
+            return False
+
+    def stats(self) -> RelayStats:
+        """Get relay statistics.
+
+        Returns:
+            RelayStats with current server metrics.
+        """
+        resp = self._client.get("/api/v1/stats")
+        resp.raise_for_status()
+        data = resp.json()
+        return RelayStats(
+            publishers=data.get("publishers", 0),
+            subscribers=data.get("subscribers", 0),
+            tracks=data.get("tracks", 0),
+            bytes_received=data.get("bytes_received", 0),
+            bytes_sent=data.get("bytes_sent", 0),
+            uptime_secs=data.get("uptime_secs", 0),
+        )
+
+    def list_streams(self) -> list[StreamInfo]:
+        """List active streams.
+
+        Returns:
+            List of StreamInfo for each active stream.
+        """
+        resp = self._client.get("/api/v1/streams")
+        resp.raise_for_status()
+        return [
+            StreamInfo(
+                name=s.get("name", ""),
+                subscribers=s.get("subscribers", 0),
+            )
+            for s in resp.json()
+        ]

lvqr-0.1.0/python/lvqr/types.py

@@ -0,0 +1,23 @@
+"""Data types for the LVQR admin API."""
+
+from dataclasses import dataclass
+
+
+@dataclass
+class RelayStats:
+    """Relay server statistics."""
+
+    publishers: int = 0
+    subscribers: int = 0
+    tracks: int = 0
+    bytes_received: int = 0
+    bytes_sent: int = 0
+    uptime_secs: int = 0
+
+
+@dataclass
+class StreamInfo:
+    """Information about an active stream."""
+
+    name: str
+    subscribers: int = 0

lvqr-0.1.0/tests/test_client.py

@@ -0,0 +1,76 @@
+"""Tests for the LVQR Python client."""
+
+import json
+from unittest.mock import MagicMock, patch
+
+from lvqr import LvqrClient, RelayStats, StreamInfo
+
+
+class TestTypes:
+    def test_relay_stats_defaults(self):
+        stats = RelayStats()
+        assert stats.publishers == 0
+        assert stats.subscribers == 0
+        assert stats.tracks == 0
+
+    def test_stream_info(self):
+        info = StreamInfo(name="live/test", subscribers=5)
+        assert info.name == "live/test"
+        assert info.subscribers == 5
+
+
+class TestClient:
+    def test_context_manager(self):
+        with LvqrClient("http://localhost:8080") as client:
+            assert client.base_url == "http://localhost:8080"
+
+    def test_base_url_trailing_slash(self):
+        client = LvqrClient("http://localhost:8080/")
+        assert client.base_url == "http://localhost:8080"
+        client.close()
+
+    @patch("httpx.Client.get")
+    def test_healthz_ok(self, mock_get):
+        mock_get.return_value = MagicMock(status_code=200)
+        client = LvqrClient("http://localhost:8080")
+        assert client.healthz() is True
+        client.close()
+
+    @patch("httpx.Client.get")
+    def test_healthz_down(self, mock_get):
+        import httpx
+        mock_get.side_effect = httpx.ConnectError("connection refused")
+        client = LvqrClient("http://localhost:8080")
+        assert client.healthz() is False
+        client.close()
+
+    @patch("httpx.Client.get")
+    def test_stats(self, mock_get):
+        mock_get.return_value = MagicMock(
+            status_code=200,
+            json=lambda: {"tracks": 3, "subscribers": 10, "publishers": 1},
+            raise_for_status=lambda: None,
+        )
+        client = LvqrClient("http://localhost:8080")
+        stats = client.stats()
+        assert stats.tracks == 3
+        assert stats.subscribers == 10
+        assert stats.publishers == 1
+        client.close()
+
+    @patch("httpx.Client.get")
+    def test_list_streams(self, mock_get):
+        mock_get.return_value = MagicMock(
+            status_code=200,
+            json=lambda: [
+                {"name": "live/stream1", "subscribers": 5},
+                {"name": "live/stream2", "subscribers": 12},
+            ],
+            raise_for_status=lambda: None,
+        )
+        client = LvqrClient("http://localhost:8080")
+        streams = client.list_streams()
+        assert len(streams) == 2
+        assert streams[0].name == "live/stream1"
+        assert streams[1].subscribers == 12
+        client.close()