benchlab-pytools 3.1.0__tar.gz

benchlab_pytools-3.1.0/.flake8

@@ -0,0 +1,2 @@
+[flake8]
+exclude = benchlab/vu/VU-Server,__pycache__,.git,.pytest_cache

benchlab_pytools-3.1.0/.gitignore

@@ -0,0 +1,241 @@
+# Benchlab specific files
+*.db
+*.db-journal
+*.config
+*.pid.lock
+.benchlab_prefs.json
+my_config.json
+/logs/
+benchlab/vu/generated/
+benchlab/vu/VU-Server/upload/
+benchlab/link/DEV_NOTES.md
+benchlab/link/link.config
+benchlab/link/.env
+
+# 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
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# 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 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+#Cline Settings
+./clinerules/
+clinerules.md
+benchlab/vu/generated/Ambient_Temp_31adb92f7d8c50f2ef571b0e57623d4a_logo.png
+benchlab/vu/generated/HPWR1_Current_3bdca09ec192687fe4737b7eab9b5a40_logo.png
+benchlab/vu/generated/Humidity_5841b6aff86e7995ed175c5d6461a5cf_logo.png
+benchlab/vu/generated/SYS_Power_7932c00b5744a5d26d25928e058c8231_logo.png
+benchlab/vu/VU-Server/upload/img_4A0027000650564139323920
+benchlab/vu/VU-Server/upload/img_4A0038000650564139323920
+benchlab/vu/VU-Server/upload/img_35002F000650564139323920
+benchlab/vu/VU-Server/upload/img_890024000650564139323920
+benchlab/vu/VU-Server/upload/tmp_4A0027000650564139323920
+benchlab/vu/VU-Server/upload/tmp_4A0038000650564139323920
+benchlab/vu/VU-Server/upload/tmp_35002F000650564139323920
+benchlab/vu/VU-Server/upload/tmp_890024000650564139323920
+benchlab/vu/VU-Server/upload/img_4A0027000650564139323920
+benchlab/vu/VU-Server/upload/img_4A0038000650564139323920
+benchlab/vu/VU-Server/upload/img_35002F000650564139323920
+benchlab/vu/VU-Server/upload/img_890024000650564139323920

benchlab_pytools-3.1.0/CHANGELOG.md

@@ -0,0 +1,122 @@
+# Changelog
+
+All notable changes to BENCHLAB PyTools are documented here. Format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versioning follows
+[SemVer](https://semver.org/).
+
+## [3.1.0] - 2026-09-08
+
+### Added
+- `service_ws` data source: consumes the BENCHLAB service `/events`
+  WebSocket event stream (added in the C# service's PR #76). Telemetry is
+  pushed at the service's own poll cadence rather than polled, and device
+  connect/disconnect is reflected without a manual rescan. Output is
+  normalized to the same shape as `service_http`. New CLI flags
+  `--service-ws-url` (default `ws://localhost:8585/events`) and
+  `--service-token`; new optional-dependency group
+  `benchlab-pytools[service_ws]` (`websockets`).
+
+## [3.0.4] - 2026-08-18
+
+### Fixed
+- 12VHPWR tab per-pin sense lines (`HPWR{1,2}_W{1..6}`) read 0.0 over
+  `service_http`/`named_pipe`, even though other apps using the same
+  `service_http` API showed correct values. The C# service's telemetry
+  normalization mapped the HPWR1/HPWR2 rail summaries but never mapped
+  the 12 individual per-pin sense-line sensors, so their C#
+  `ShortName`s (`HPWR{n}_W{m}_{P,I,V}`) passed through unmapped instead
+  of becoming the `..._{Power,Current,Voltage}` keys the TUI reads.
+
+## [3.0.3] - 2026-08-18
+
+### Fixed
+- TUI: the 12VHPWR tab's Voltage section was cut off with no way to
+  scroll, since `MIN_TERMINAL_ROWS` (35) was well under the ~48 rows
+  the stacked Power/Current/Voltage layout plus status bar actually
+  needs. Raised to 48.
+- `mqtt`, `service_http`, and `named_pipe` data sources never surfaced
+  `vendor_id`/`product_id`/`firmware_version`, so the Fleet TUI's
+  Model column (BL1 vs BL2 detection) was always wrong for these
+  sources:
+  - `mqtt`: the publisher's retained info payload only sent
+    `uid`/`com_port`/`firmware`; it now also reads
+    `ProductId`/`VendorId`/`FwVersion` via `read_device()` and
+    computes `variant`.
+  - `named_pipe`: the C# service's camelCase `productId` is now
+    mapped to the PascalCase keys the TUI expects
+    (`vendorId`/`firmwareVersion` also mapped), with `variant`
+    computed — field names verified against the
+    `BENCHLAB.BENCHLAB_Service` source.
+  - `service_http`: added a device-info normalization step (the C#
+    HTTP API only ever sends `productId`, confirmed against source —
+    vendor/firmware are unavailable there and default to unknown).
+
+## [3.0.2] - 2026-08-18
+
+### Fixed
+- Several f-strings had their `{...}` expression split across a line
+  break, which is [PEP 701](https://peps.python.org/pep-0701/) syntax
+  only valid on Python 3.12+. Despite `requires-python = ">=3.10"`, this
+  raised `SyntaxError` immediately on 3.10/3.11 (e.g. `benchlab -tui`
+  failing with `SyntaxError: unterminated string literal` in
+  `benchlab/core/datasource.py`) — invisible in CI since every workflow
+  pins Python 3.13. Collapsed all such f-strings back onto single lines
+  across 27 files.
+
+## [3.0.1] - 2026-08-18
+
+### Fixed
+- PyPI install was broken: `bootstrap.py` and the core `requirements.txt`
+  lived at the repo root and were never included in the wheel (only
+  `benchlab/` is packaged), so `pip install benchlab-pytools` followed by
+  `benchlab ...` failed with `ModuleNotFoundError: No module named
+  'bootstrap'`. Both files moved into `benchlab/`, with internal imports
+  updated to relative imports.
+- `pywin32` was missing from `pyproject.toml`'s core dependencies, so
+  PyPI installs on Windows did not pull it in despite the `named_pipe`
+  data source depending on it. Added `pywin32>=306; platform_system ==
+  'Windows'` alongside the existing `windows-curses` entry.
+
+## [3.0.0] - 2026-08-15
+
+### Added
+- Packaging: `pyproject.toml` for `pip install benchlab-pytools`, with
+  per-tool optional extras (`[tui]`, `[graph]`, `[vu]`, `[wigidash]`,
+  `[mqtt]`, `[restapi]`, `[csv_log]`, `[hwinfo]`, `[all]`) and a `benchlab`
+  console-script entry point.
+- `--version` CLI flag.
+- Tag-triggered release workflow: builds and tests the package, publishes
+  to PyPI, and attaches a source zip + wheel to a GitHub Release.
+- `benchlab/vu/VU-Server/NOTICE.md` documenting redistribution permission
+  for the vendored VU-Server app.
+- flake8 lint CI gate (`.flake8`, `.github/workflows/lint.yml`) for pull
+  requests targeting `main`.
+
+### Changed
+- Link: `CloudMQTTClient` now pins paho-mqtt's `callback_api_version`
+  explicitly to `VERSION2` instead of relying on the deprecated implicit
+  default, with `on_connect`/`on_disconnect` updated to the matching
+  5-arg signature.
+- Link: MQTT topic pattern now also supports a `{client_uuid}` token
+  alongside `{uid}` (`LINK_TOPIC_PATTERN`), so deployments needing a
+  `clients/{client_uuid}/devices/{uid}/...` scheme are configurable
+  without code changes.
+- Whole codebase now passes flake8's default ruleset (2,443 findings
+  fixed: unused imports/variables, an undefined-name issue in
+  `benchlab/core/datasource.py` resolved via a `TYPE_CHECKING`-guarded
+  import, and formatting/line-length cleanup — no behavior changes).
+
+## [0.8.2] - Unreleased (pre-packaging baseline)
+
+Snapshot of the codebase at the point packaging work began. Interactive
+menu (prompt_toolkit-based), TUI, CSV logger, FastAPI server, graph, HWiNFO
+export, MQTT publisher, VU dials, WigiDash, and config import/export tools,
+sharing a common data-source layer (direct serial, FastAPI, MQTT, named
+pipe, service HTTP, service WebSocket).
+
+[3.1.0]: https://github.com/BenchLab-io/benchlab-pytools/compare/v3.0.4...v3.1.0
+[3.0.4]: https://github.com/BenchLab-io/benchlab-pytools/compare/v3.0.3...v3.0.4
+[3.0.3]: https://github.com/BenchLab-io/benchlab-pytools/compare/v3.0.2...v3.0.3
+[3.0.2]: https://github.com/BenchLab-io/benchlab-pytools/compare/v3.0.1...v3.0.2
+[3.0.1]: https://github.com/BenchLab-io/benchlab-pytools/compare/v3.0.0...v3.0.1
+[3.0.0]: https://github.com/BenchLab-io/benchlab-pytools/compare/v0.8.2...v3.0.0

benchlab_pytools-3.1.0/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing to BENCHLAB PyTools
+
+## Development setup
+
+```bash
+git clone https://github.com/BenchLab-io/benchlab-pytools.git
+cd benchlab-pytools
+pip install -r benchlab/requirements.txt
+pip install -r benchlab/csv_log/requirements.txt
+pip install -r benchlab/graph/requirements.txt
+pip install -r benchlab/wigidash/requirements.txt
+pip install -r benchlab/vu/requirements.txt
+pip install pytest
+```
+
+Or install everything (including test tooling) via the package extras:
+
+```bash
+pip install -e ".[all]"
+pip install pytest
+```
+
+Requires Python 3.10+.
+
+## Running tests
+
+```bash
+pytest
+```
+
+CI (`.github/workflows/pycore-compat.yml`) runs the full suite on
+Windows against both the pinned `benchlab-pycore` version and the latest
+release on PyPI, to catch drift between this repo and that package's
+published API early (see issue #9).
+
+## Adding a new tool
+
+1. Add an entry to `CONSUMER_TOOLS` in `benchlab/tools.py` with `name`,
+   `flag`, `module`, `function`, and `requirements`.
+2. Implement the tool's entry function, accepting an `args` namespace (see
+   `benchlab/launcher.py::_build_args_namespace`).
+3. Add a CLI flag in `benchlab/main.py::get_parser()` and dispatch it in
+   `launch_mode()`.
+4. Add a `requirements.txt` in the tool's directory if it needs extra
+   dependencies, and a matching extra in `pyproject.toml`.
+5. Write a `README.md` in the tool's directory following the style of the
+   existing ones.
+6. Add tests and wire them into `.github/workflows/pycore-compat.yml`.
+
+## Versioning and releases
+
+The version lives in `benchlab/__init__.py::__version__` and is the single
+source of truth (`pyproject.toml` reads it dynamically). To cut a release:
+
+1. Bump `__version__` in `benchlab/__init__.py`.
+2. Move the `[Unreleased]` section in `CHANGELOG.md` to a new version
+   heading with today's date.
+3. Commit, then tag: `git tag vX.Y.Z && git push origin vX.Y.Z`.
+4. The `release` workflow builds, tests, publishes to PyPI, and creates a
+   GitHub Release with the wheel/sdist and a source zip attached.
+
+## Pull requests
+
+- Keep changes scoped to one tool/concern where possible — this repo is
+  organized as independent subpackages under `benchlab/` sharing a common
+  core.
+- Include or update tests for behavior changes.
+- CI must pass before merge.

benchlab_pytools-3.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 BENCHLAB.io
+
+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.