streamdoctor 0.1.0__tar.gz

streamdoctor-0.1.0/LICENSE

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

streamdoctor-0.1.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: streamdoctor
+Version: 0.1.0
+Summary: Video stream diagnostics and root-cause analysis toolkit
+Author: StreamDoctor Contributors
+License-Expression: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.95.0
+Requires-Dist: uvicorn[standard]>=0.22.0
+Requires-Dist: requests>=2.0
+Requires-Dist: httpx>=0.24.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# StreamDoctor
+
+StreamDoctor is an open-source Python toolkit for inspecting and diagnosing live video stream health. It helps detect timing issues, FPS drift, frame gaps, jitter, PTS anomalies, GOP behavior, and other stream-quality signals from real camera or media sources.
+
+## Overview
+
+The project is designed for technical users who want a lightweight, evidence-based way to understand whether a live stream is delivering frames at the expected cadence and whether the problem is likely related to encoder side, transport, or stream delivery.
+
+StreamDoctor focuses on:
+
+- RTMP/RTSP-style stream inspection
+- live frame and packet analysis
+- declared-vs-measured FPS comparison
+- jitter and timing gap detection
+- PTS/DTS anomaly reporting
+- diagnostic summaries and recommendations
+
+## Features
+
+- `streamdoctor inspect <url>`: inspect stream/container metadata
+- `streamdoctor analyze <url> --duration <seconds>`: run a timed live analysis
+- JSON-friendly diagnostic output patterns for automation workflows
+- Python API for integration into custom tooling
+- evidence-first diagnosis instead of unsupported root-cause assumptions
+
+## Installation
+
+### 1) Python requirement
+
+- Python 3.10 or newer
+
+### 2) Install the package
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install --upgrade pip
+python -m pip install -r requirements.txt
+python -m pip install -e .
+```
+
+On Windows PowerShell:
+
+```powershell
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+python -m pip install --upgrade pip
+python -m pip install -r requirements.txt
+python -m pip install -e .
+```
+
+### 3) Install FFmpeg/FFprobe separately
+
+This project does not bundle FFmpeg or FFprobe. You must install them on your system and ensure `ffprobe` is available on your `PATH`.
+
+Examples:
+
+- Ubuntu/Debian: `sudo apt install ffmpeg`
+- macOS (Homebrew): `brew install ffmpeg`
+- Windows: install FFmpeg and add it to `PATH`
+
+
+
+## Quick start
+
+```bash
+streamdoctor --help
+streamdoctor inspect "rtmp://example.com/live/camera"
+streamdoctor analyze "rtmp://example.com/live/camera" --duration 30
+```
+
+## Notes
+
+- This project is built to analyze stream behavior from external media tooling.
+- It does not ship FFmpeg binaries or proprietary media binaries.
+- FFprobe output is used as a dependency for the time-based stream analysis pipeline.
+- The project aims to remain evidence-based and avoids claiming precise root causes without clear supporting data.
+
+## Requirements and dependency policy
+
+The Python dependencies in `requirements.txt` are the only packaged runtime libraries included with this project. FFmpeg/FFprobe are external system dependencies and are not redistributed here.
+
+## License
+
+This project is licensed under the MIT License. See `LICENSE` for details.
+
+## Third-party notices
+
+This project uses third-party Python dependencies and relies on externally installed FFmpeg/FFprobe tooling. See `THIRD_PARTY_LICENSES.md` for a summary of licensing obligations.
+
+## Security and public release note
+
+Before publishing this project publicly, remove any real stream URLs, credentials, private hostnames, and secret configuration from documentation and source files. Use placeholders such as `rtmp://example.com/live/camera` instead.

streamdoctor-0.1.0/README.md

@@ -0,0 +1,93 @@
+# StreamDoctor
+
+StreamDoctor is an open-source Python toolkit for inspecting and diagnosing live video stream health. It helps detect timing issues, FPS drift, frame gaps, jitter, PTS anomalies, GOP behavior, and other stream-quality signals from real camera or media sources.
+
+## Overview
+
+The project is designed for technical users who want a lightweight, evidence-based way to understand whether a live stream is delivering frames at the expected cadence and whether the problem is likely related to encoder side, transport, or stream delivery.
+
+StreamDoctor focuses on:
+
+- RTMP/RTSP-style stream inspection
+- live frame and packet analysis
+- declared-vs-measured FPS comparison
+- jitter and timing gap detection
+- PTS/DTS anomaly reporting
+- diagnostic summaries and recommendations
+
+## Features
+
+- `streamdoctor inspect <url>`: inspect stream/container metadata
+- `streamdoctor analyze <url> --duration <seconds>`: run a timed live analysis
+- JSON-friendly diagnostic output patterns for automation workflows
+- Python API for integration into custom tooling
+- evidence-first diagnosis instead of unsupported root-cause assumptions
+
+## Installation
+
+### 1) Python requirement
+
+- Python 3.10 or newer
+
+### 2) Install the package
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install --upgrade pip
+python -m pip install -r requirements.txt
+python -m pip install -e .
+```
+
+On Windows PowerShell:
+
+```powershell
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+python -m pip install --upgrade pip
+python -m pip install -r requirements.txt
+python -m pip install -e .
+```
+
+### 3) Install FFmpeg/FFprobe separately
+
+This project does not bundle FFmpeg or FFprobe. You must install them on your system and ensure `ffprobe` is available on your `PATH`.
+
+Examples:
+
+- Ubuntu/Debian: `sudo apt install ffmpeg`
+- macOS (Homebrew): `brew install ffmpeg`
+- Windows: install FFmpeg and add it to `PATH`
+
+
+
+## Quick start
+
+```bash
+streamdoctor --help
+streamdoctor inspect "rtmp://example.com/live/camera"
+streamdoctor analyze "rtmp://example.com/live/camera" --duration 30
+```
+
+## Notes
+
+- This project is built to analyze stream behavior from external media tooling.
+- It does not ship FFmpeg binaries or proprietary media binaries.
+- FFprobe output is used as a dependency for the time-based stream analysis pipeline.
+- The project aims to remain evidence-based and avoids claiming precise root causes without clear supporting data.
+
+## Requirements and dependency policy
+
+The Python dependencies in `requirements.txt` are the only packaged runtime libraries included with this project. FFmpeg/FFprobe are external system dependencies and are not redistributed here.
+
+## License
+
+This project is licensed under the MIT License. See `LICENSE` for details.
+
+## Third-party notices
+
+This project uses third-party Python dependencies and relies on externally installed FFmpeg/FFprobe tooling. See `THIRD_PARTY_LICENSES.md` for a summary of licensing obligations.
+
+## Security and public release note
+
+Before publishing this project publicly, remove any real stream URLs, credentials, private hostnames, and secret configuration from documentation and source files. Use placeholders such as `rtmp://example.com/live/camera` instead.

streamdoctor-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "streamdoctor"
+version = "0.1.0"
+description = "Video stream diagnostics and root-cause analysis toolkit"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    {name = "StreamDoctor Contributors"}
+]
+dependencies = [
+    "fastapi>=0.95.0",
+    "uvicorn[standard]>=0.22.0",
+    "requests>=2.0",
+    "httpx>=0.24.0"
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0"
+]
+
+[project.scripts]
+streamdoctor = "streamdoctor.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]

streamdoctor-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

streamdoctor-0.1.0/src/streamdoctor/__init__.py

@@ -0,0 +1,10 @@
+from .api import analyze_stream, analyze_and_diagnose, plan_remediation
+
+__version__ = "0.1.0"
+
+__all__ = [
+	"analyze_stream",
+	"analyze_and_diagnose",
+	"plan_remediation",
+	"__version__",
+]