vpstream 0.1.0__tar.gz

vpstream-0.1.0/.gitignore

@@ -0,0 +1,227 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# vpstream: private planning notes, validation logs and the deny list
+notes/
+# Machine-specific instructions
+*.local.md
+# Default results file of `vpstream caps`
+caps-results-*.json

vpstream-0.1.0/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+<!-- version list -->
+
+## v0.1.0 (2026-11-09)
+
+- Initial Release

vpstream-0.1.0/LICENSE

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

vpstream-0.1.0/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.5
+Name: vpstream
+Version: 0.1.0
+Summary: On-demand video streaming from a VPS, controlled over SSH or a private dashboard
+License-Expression: MIT
+License-File: LICENSE
+License-File: src/vpstream/assets/hls.js.LICENSE
+Classifier: Environment :: Console
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Video
+Requires-Python: >=3.12
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# vpstream
+
+On-demand video streaming from a VPS. The public port opens only while a stream runs, and
+everything is controlled over SSH or a private dashboard.
+
+Status: early development. This release contains only the measuring tools:
+
+| Command | What it does |
+| --- | --- |
+| `vpstream bench FILE` | Measures how fast this host copies, transcodes and burns in subtitles for a file |
+| `vpstream caps` | Serves a test page that checks what a TV browser can play |
+| `vpstream selftest` | Runs the tests shipped with the package (`--integration` uses the real ffmpeg) |
+
+## Requirements
+
+- Linux, Python 3.12 or newer
+- ffmpeg and ffprobe on `PATH` (not bundled), with libx264; libx265 and an AV1 encoder
+  (libsvtav1 or libaom-av1) for the full `caps` test set
+
+## Install
+
+```text
+pipx install "vpstream[dev]"     # the dev extra adds pytest for `vpstream selftest`
+vpstream --version
+vpstream selftest --integration
+```
+
+## `vpstream bench FILE`
+
+Encodes a sample of the file (120 seconds from about 10% in, `--sample` to change) at low CPU
+and I/O priority, and reports the speed of each step as a multiple of real time, with the
+estimated time for the whole file:
+
+- **copy:** the video copied into fMP4 HLS, audio converted to AAC
+- **transcode:** H.264 at the source resolution, for each x264 preset in `--presets`
+  (default `veryfast,medium`); HDR sources are tone mapped
+- **burn-in:** the first image, ASS or SSA subtitle track (or `--sub N`) drawn into the video;
+  for ASS tracks, font substitutions reported by libass are listed
+
+`--json PATH` saves the results.
+
+## `vpstream caps`
+
+Generates short test clips (H.264, HEVC and AV1 in 8 and 10 bit, two audio tracks, WebVTT),
+then serves a page on port 1337 (`--port`) that a TV browser opens at
+`http://<server-ip>:1337/caps`. The page is driven with the arrow keys and OK. It tests MP4 and
+HLS playback (hls.js and native), a subtitle overlay, audio track switching, download speed,
+and records which remote keys reach the page. Results are sent back and saved to
+`caps-results-*.json`. The server stops after 60 minutes (`--ttl`).
+
+Clips are cached under `~/.cache/vpstream`. `--clips DIR` must be a new or empty folder, or one
+that `vpstream caps` made before; any other folder is refused, never cleared. `--regen` makes
+the clips again.
+
+The port must be reachable: open it in your firewall for the test and close it afterwards.
+
+## Development
+
+```text
+python -m venv .venv && .venv/bin/pip install -e ".[dev]"
+.venv/bin/pytest                  # unit tests
+.venv/bin/pytest --integration    # also the tests that run ffmpeg
+git config core.hooksPath .githooks
+```
+
+Pull requests need a Conventional Commit title (`feat: ...`, `fix: ...`). Releases are made
+from `main` by python-semantic-release.
+
+hls.js (Apache-2.0) is bundled in `src/vpstream/assets`, with its version in `hls.js.version`.
+`python scripts/update-hlsjs.py` updates it from npm (checked against npm's sha512 integrity;
+`--version X` for a given release, `--check` to only compare). A weekly workflow runs the same
+script and opens a pull request when a new release is out.
+
+## License
+
+MIT

vpstream-0.1.0/README.md

@@ -0,0 +1,76 @@
+# vpstream
+
+On-demand video streaming from a VPS. The public port opens only while a stream runs, and
+everything is controlled over SSH or a private dashboard.
+
+Status: early development. This release contains only the measuring tools:
+
+| Command | What it does |
+| --- | --- |
+| `vpstream bench FILE` | Measures how fast this host copies, transcodes and burns in subtitles for a file |
+| `vpstream caps` | Serves a test page that checks what a TV browser can play |
+| `vpstream selftest` | Runs the tests shipped with the package (`--integration` uses the real ffmpeg) |
+
+## Requirements
+
+- Linux, Python 3.12 or newer
+- ffmpeg and ffprobe on `PATH` (not bundled), with libx264; libx265 and an AV1 encoder
+  (libsvtav1 or libaom-av1) for the full `caps` test set
+
+## Install
+
+```text
+pipx install "vpstream[dev]"     # the dev extra adds pytest for `vpstream selftest`
+vpstream --version
+vpstream selftest --integration
+```
+
+## `vpstream bench FILE`
+
+Encodes a sample of the file (120 seconds from about 10% in, `--sample` to change) at low CPU
+and I/O priority, and reports the speed of each step as a multiple of real time, with the
+estimated time for the whole file:
+
+- **copy:** the video copied into fMP4 HLS, audio converted to AAC
+- **transcode:** H.264 at the source resolution, for each x264 preset in `--presets`
+  (default `veryfast,medium`); HDR sources are tone mapped
+- **burn-in:** the first image, ASS or SSA subtitle track (or `--sub N`) drawn into the video;
+  for ASS tracks, font substitutions reported by libass are listed
+
+`--json PATH` saves the results.
+
+## `vpstream caps`
+
+Generates short test clips (H.264, HEVC and AV1 in 8 and 10 bit, two audio tracks, WebVTT),
+then serves a page on port 1337 (`--port`) that a TV browser opens at
+`http://<server-ip>:1337/caps`. The page is driven with the arrow keys and OK. It tests MP4 and
+HLS playback (hls.js and native), a subtitle overlay, audio track switching, download speed,
+and records which remote keys reach the page. Results are sent back and saved to
+`caps-results-*.json`. The server stops after 60 minutes (`--ttl`).
+
+Clips are cached under `~/.cache/vpstream`. `--clips DIR` must be a new or empty folder, or one
+that `vpstream caps` made before; any other folder is refused, never cleared. `--regen` makes
+the clips again.
+
+The port must be reachable: open it in your firewall for the test and close it afterwards.
+
+## Development
+
+```text
+python -m venv .venv && .venv/bin/pip install -e ".[dev]"
+.venv/bin/pytest                  # unit tests
+.venv/bin/pytest --integration    # also the tests that run ffmpeg
+git config core.hooksPath .githooks
+```
+
+Pull requests need a Conventional Commit title (`feat: ...`, `fix: ...`). Releases are made
+from `main` by python-semantic-release.
+
+hls.js (Apache-2.0) is bundled in `src/vpstream/assets`, with its version in `hls.js.version`.
+`python scripts/update-hlsjs.py` updates it from npm (checked against npm's sha512 integrity;
+`--version X` for a given release, `--check` to only compare). A weekly workflow runs the same
+script and opens a pull request when a new release is out.
+
+## License
+
+MIT

vpstream-0.1.0/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+requires = ["hatchling>=1.25"]
+build-backend = "hatchling.build"
+
+[project]
+name = "vpstream"
+version = "0.1.0"
+description = "On-demand video streaming from a VPS, controlled over SSH or a private dashboard"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE", "src/vpstream/assets/hls.js.LICENSE"]
+requires-python = ">=3.12"
+dependencies = []
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: POSIX :: Linux",
+    "Environment :: Console",
+    "Topic :: Multimedia :: Video",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8"]
+
+[project.scripts]
+vpstream = "vpstream.cli:main"
+
+[tool.hatch.build.targets.sdist]
+include = ["src/vpstream", "README.md", "LICENSE", "CHANGELOG.md"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/vpstream"]
+
+[tool.pytest.ini_options]
+testpaths = ["src/vpstream/tests"]
+addopts = "-p no:cacheprovider"
+
+[tool.ruff]
+target-version = "py312"
+line-length = 100
+src = ["src"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "SIM", "RUF"]
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+files = ["src/vpstream"]
+exclude = ["src/vpstream/tests/"]
+
+[tool.semantic_release]
+commit_parser = "conventional"
+tag_format = "v{version}"
+version_toml = ["pyproject.toml:project.version"]
+allow_zero_version = true
+major_on_zero = false
+build_command = "python -m pip install build && python -m build"
+
+[tool.semantic_release.branches.main]
+match = "main"
+prerelease = false
+
+[tool.semantic_release.changelog.default_templates]
+changelog_file = "CHANGELOG.md"

vpstream-0.1.0/src/vpstream/__init__.py

@@ -0,0 +1,10 @@
+"""On-demand video streaming from a VPS."""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("vpstream")
+except PackageNotFoundError:  # running from a source tree without an install
+    __version__ = "0.0.0+unknown"

vpstream-0.1.0/src/vpstream/__main__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from vpstream.cli import main
+
+raise SystemExit(main())

vpstream-0.1.0/src/vpstream/assets/__init__.py

@@ -0,0 +1 @@
+"""Files served to browsers: pages, scripts and the bundled hls.js."""

vpstream-0.1.0/src/vpstream/assets/caps.html

@@ -0,0 +1,54 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<title>vpstream capability test</title>
+<style>
+  html, body { margin: 0; background: #111; color: #eee; font: 22px/1.4 sans-serif; }
+  main { max-width: 1100px; margin: 0 auto; padding: 16px; }
+  h1 { font-size: 30px; margin: 8px 0 4px; }
+  p { margin: 6px 0; }
+  .muted { color: #aaa; }
+  button { font: inherit; font-size: 24px; padding: 14px 26px; margin: 6px 10px 6px 0;
+           background: #2a2a2a; color: #fff; border: 3px solid #555; border-radius: 10px; }
+  button:focus { outline: none; border-color: #ffd400; background: #3a3a10; }
+  button[disabled] { opacity: .4; }
+  #stage { font-size: 26px; margin: 12px 0; min-height: 1.4em; }
+  #player { position: relative; width: 640px; max-width: 100%; background: #000;
+            margin: 10px 0; height: 360px; }
+  #player video { width: 100%; height: 100%; display: block; }
+  #overlay { position: absolute; left: 0; right: 0; top: 6%; text-align: center;
+             pointer-events: none; }
+  #overlay span { background: rgba(0,0,0,.75); color: #ffd400; padding: 4px 12px;
+                  font-size: 26px; border-radius: 6px; }
+  #ask { margin: 10px 0; }
+  #ask p { font-size: 24px; }
+  table { border-collapse: collapse; width: 100%; font-size: 18px; margin: 8px 0 18px; }
+  td, th { border-bottom: 1px solid #333; padding: 4px 8px; text-align: left; }
+  .pass { color: #6f6; } .fail { color: #f66; } .skip { color: #aaa; }
+  #keys { font-family: monospace; font-size: 18px; }
+</style>
+</head>
+<body>
+<main>
+  <h1>vpstream capability test</h1>
+  <p class="muted">Use the arrow keys to move and OK to press. Results are sent to the server as each part finishes.</p>
+  <div>
+    <button id="start">Start all tests</button>
+    <button id="speedonly">Speed test only</button>
+  </div>
+  <div id="stage">Loading…</div>
+  <div id="player"><div id="overlay"></div></div>
+  <div id="ask"></div>
+  <div id="controls"></div>
+  <p id="keys">Remote keys: press every button on the remote (arrows, OK, Back, Play/Pause, colors). Last key: none</p>
+  <h2>Results</h2>
+  <table id="results"><thead><tr><th>Test</th><th>Result</th><th>Detail</th></tr></thead><tbody></tbody></table>
+  <h2>Browser</h2>
+  <table id="env"><tbody></tbody></table>
+</main>
+<script src="/caps/hls.min.js"></script>
+<script src="/caps/caps.js"></script>
+</body>
+</html>