benchlab-pytools 3.0.0__tar.gz

benchlab_pytools-3.0.0/.flake8

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

benchlab_pytools-3.0.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.0.0/CHANGELOG.md

@@ -0,0 +1,44 @@
+# 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.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).
+
+[3.0.0]: https://github.com/BenchLab-io/benchlab-pytools/compare/v0.8.2...v3.0.0

benchlab_pytools-3.0.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 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.0.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.

benchlab_pytools-3.0.0/PKG-INFO

@@ -0,0 +1,239 @@
+Metadata-Version: 2.5
+Name: benchlab-pytools
+Version: 3.0.0
+Summary: Python control suite for BENCHLAB telemetry devices
+Project-URL: Homepage, https://benchlab.io/
+Project-URL: Repository, https://github.com/BenchLab-io/benchlab-pytools
+Project-URL: Issues, https://github.com/BenchLab-io/benchlab-pytools/issues
+Author: BENCHLAB.io
+License-Expression: MIT
+License-File: LICENSE
+Keywords: benchlab,hardware-monitoring,telemetry
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Hardware
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.10
+Requires-Dist: benchlab-pycore>=0.5.1
+Requires-Dist: packaging<26.0,>=23.0
+Requires-Dist: python-dotenv<2.0,>=1.0.0
+Requires-Dist: textual<9.0,>=0.60
+Requires-Dist: windows-curses>=2.4.1; platform_system == 'Windows'
+Provides-Extra: all
+Requires-Dist: amqtt<0.13.0,>=0.12.0; extra == 'all'
+Requires-Dist: benchlab-pycore>=0.5.1; extra == 'all'
+Requires-Dist: blessed>=1.20.0; extra == 'all'
+Requires-Dist: dearpygui>=2.1.1; extra == 'all'
+Requires-Dist: fastapi==0.111.1; extra == 'all'
+Requires-Dist: libusb-package>=1.0.26.1; (sys_platform == 'win32') and extra == 'all'
+Requires-Dist: matplotlib>=3.10.7; extra == 'all'
+Requires-Dist: numpy; extra == 'all'
+Requires-Dist: numpy>=2.2.0; extra == 'all'
+Requires-Dist: paho-mqtt<3.0,>=2.0; extra == 'all'
+Requires-Dist: pillow>=10.0.0; extra == 'all'
+Requires-Dist: pillow>=11.3.0; extra == 'all'
+Requires-Dist: pydantic>=2.0.0; extra == 'all'
+Requires-Dist: pyserial>=3.5; extra == 'all'
+Requires-Dist: python-dotenv==1.1.1; extra == 'all'
+Requires-Dist: pyusb>=1.3.1; extra == 'all'
+Requires-Dist: pyyaml<7.0,>=6.0; extra == 'all'
+Requires-Dist: pyyaml>=6.0; extra == 'all'
+Requires-Dist: requests>=2.31.0; extra == 'all'
+Requires-Dist: ruamel-yaml; extra == 'all'
+Requires-Dist: tornado; extra == 'all'
+Requires-Dist: uvicorn[standard]==0.24.0; extra == 'all'
+Provides-Extra: csv-log
+Requires-Dist: benchlab-pycore>=0.5.1; extra == 'csv-log'
+Requires-Dist: pyserial>=3.5; extra == 'csv-log'
+Provides-Extra: graph
+Requires-Dist: dearpygui>=2.1.1; extra == 'graph'
+Requires-Dist: pyserial>=3.5; extra == 'graph'
+Provides-Extra: hwinfo
+Requires-Dist: pyserial>=3.5; extra == 'hwinfo'
+Provides-Extra: mqtt
+Requires-Dist: amqtt<0.13.0,>=0.12.0; extra == 'mqtt'
+Requires-Dist: paho-mqtt<3.0,>=2.0; extra == 'mqtt'
+Requires-Dist: pyyaml<7.0,>=6.0; extra == 'mqtt'
+Provides-Extra: restapi
+Requires-Dist: fastapi==0.111.1; extra == 'restapi'
+Requires-Dist: pydantic>=2.0.0; extra == 'restapi'
+Requires-Dist: pyserial>=3.5; extra == 'restapi'
+Requires-Dist: python-dotenv==1.1.1; extra == 'restapi'
+Requires-Dist: uvicorn[standard]==0.24.0; extra == 'restapi'
+Provides-Extra: tui
+Requires-Dist: pyserial>=3.5; extra == 'tui'
+Provides-Extra: vu
+Requires-Dist: blessed>=1.20.0; extra == 'vu'
+Requires-Dist: numpy; extra == 'vu'
+Requires-Dist: pillow>=10.0.0; extra == 'vu'
+Requires-Dist: pyserial>=3.5; extra == 'vu'
+Requires-Dist: pyyaml>=6.0; extra == 'vu'
+Requires-Dist: requests>=2.31.0; extra == 'vu'
+Requires-Dist: ruamel-yaml; extra == 'vu'
+Requires-Dist: tornado; extra == 'vu'
+Provides-Extra: wigidash
+Requires-Dist: libusb-package>=1.0.26.1; (sys_platform == 'win32') and extra == 'wigidash'
+Requires-Dist: matplotlib>=3.10.7; extra == 'wigidash'
+Requires-Dist: numpy>=2.2.0; extra == 'wigidash'
+Requires-Dist: pillow>=11.3.0; extra == 'wigidash'
+Requires-Dist: pyserial>=3.5; extra == 'wigidash'
+Requires-Dist: pyusb>=1.3.1; extra == 'wigidash'
+Description-Content-Type: text/markdown
+
+# BENCHLAB PyTools
+
+BENCHLAB PyTools is the Python-based control suite for BENCHLAB telemetry devices. It provides a shared telemetry pipeline — device discovery, data sourcing, and process management — plus a set of consumer tools built on top of it:
+
+- **TUI** — interactive terminal dashboard for live monitoring
+- **CSV Logger** — fleet-wide telemetry logging for offline analysis
+- **FastAPI Server** — REST API for telemetry, exposed for other tools/integrations
+- **Graph** — DearPyGui-based real-time sensor graphing
+- **HWiNFO Export** — exposes sensors as HWiNFO64 custom sensors
+- **MQTT Publisher** — publishes telemetry to a local or remote MQTT broker
+- **Link** — publishes telemetry to the BENCHLAB cloud (SaaS) MQTT broker
+- **VU Dials** — analog-style VU meter dial display and configuration
+- **WigiDash** — telemetry/graph display on a G.SKILL WigiDash panel
+- **Config Tool** — import/export device configuration (fan curves, RGB, etc.) via JSON
+
+All tools share a common data-source layer, so the same telemetry can be read directly from a device, through a FastAPI server, over MQTT, or via the Windows BENCHLAB service — locally or remotely — without changing the consumer tool.
+
+---
+
+## Installation
+
+Requires Python 3.10+.
+
+```bash
+pip install -r requirements.txt
+```
+
+Each tool has its own `requirements.txt` (e.g. `benchlab/graph/requirements.txt`, `benchlab/vu/requirements.txt`). The launcher installs a tool's requirements automatically the first time it's run — you generally don't need to install them by hand.
+
+---
+
+## Usage
+
+### Interactive Menu
+
+Run with no arguments to enter the interactive launcher:
+
+```bash
+python benchlab.py
+```
+
+or equivalently:
+
+```bash
+python -m benchlab
+```
+
+The interactive menu (prompt_toolkit-based, with a plain-input fallback if `prompt_toolkit` isn't installed) lets you pick a data source and one or more tools, then launches them — installing any missing per-tool dependencies along the way.
+
+### Command-Line Flags
+
+Each tool can also be launched directly with a flag:
+
+```bash
+python -m benchlab -tui         # Interactive terminal dashboard
+python -m benchlab -logfleet    # CSV logger (no TUI)
+python -m benchlab -fastapi     # FastAPI telemetry server
+python -m benchlab -graph       # DearPyGui graph
+python -m benchlab -hwinfo      # HWiNFO custom sensor export
+python -m benchlab -mqtt [broker]  # MQTT publisher (default broker: localhost)
+python -m benchlab -link        # Publish telemetry to BENCHLAB cloud (Link)
+python -m benchlab -vu          # VU analog dials
+python -m benchlab -vuconfig    # VU dial configuration UI
+python -m benchlab -wigidash    # WigiDash display
+python -m benchlab -config ...  # Device configuration import/export
+```
+
+Running with no flags is equivalent to launching the interactive menu.
+
+### Data Sources
+
+Most tools accept `--source` to choose where telemetry comes from:
+
+| Source | Description |
+|---|---|
+| `direct` (default) | Direct USB-serial connection via `benchlab-pycore` |
+| `fastapi` | Local FastAPI server, started automatically if not already running |
+| `fastapi_custom` | Remote FastAPI server — requires `--api-url` |
+| `mqtt` | Local MQTT broker + publisher, started automatically if needed |
+| `mqtt_custom` | Remote/existing MQTT broker — requires `--mqtt-broker`/`--mqtt-port` |
+| `named_pipe` | Windows BENCHLAB service (`BL_Service`) via named pipes — Windows only |
+| `service_http` | Windows BENCHLAB service HTTP API — requires `--service-url` (default `http://localhost:8585`) |
+
+Common connection flags:
+
+```
+--source SOURCE          direct | fastapi | fastapi_custom | mqtt | mqtt_custom | named_pipe | service_http
+--api-url URL             FastAPI base URL (default: http://127.0.0.1:8000)
+--api-port PORT           FastAPI port (default: 8000)
+--mqtt-broker HOST         MQTT broker host (default: localhost)
+--mqtt-port PORT           MQTT broker port (default: 1883)
+--service-url URL          BENCHLAB Windows service HTTP API URL (default: http://localhost:8585)
+-i, --interval SECONDS     Refresh interval (default: 1.0)
+```
+
+When a source needs a background service (`fastapi`, `mqtt`), the launcher starts and health-checks it automatically, and tears it down on exit. Not every tool supports every source — the config tool, for example, only supports `direct` and `named_pipe`. See each tool's README for specifics.
+
+### Launch Profiles
+
+A named profile can bundle a data source and a set of tools to start together:
+
+```bash
+python -m benchlab --profile gskill_ctex26
+```
+
+Profiles are defined in `benchlab/tools.py` (`LAUNCH_PROFILES`). Each spawns its tools in separate terminal windows and manages them as a group.
+
+---
+
+## Architecture
+
+- `benchlab/main.py` — CLI argument parsing and mode dispatch (`launch_mode()`)
+- `benchlab/launcher.py` — in-process and multi-terminal tool launching, process lifecycle
+- `benchlab/sources.py` — data-source detection, startup, and teardown for all supported sources
+- `benchlab/tools.py` — the `CONSUMER_TOOLS` registry (tool metadata, module/function to invoke, dependencies) and `LAUNCH_PROFILES`
+- `benchlab/menu.py` / `benchlab/menu_classic.py` — interactive terminal menu (prompt_toolkit, with a plain-input fallback)
+- `benchlab/core/` — shared internals used by every tool: device discovery, the data-source abstraction, process management, retry logic. See [benchlab/core/README.md](benchlab/core/README.md).
+
+Each consumer tool lives in its own subpackage under `benchlab/` with its own README, and (where needed) its own `requirements.txt`.
+
+### 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 in its module, accepting an `args` namespace (see `benchlab/launcher.py::_build_args_namespace`).
+3. Add a CLI flag for it in `benchlab/main.py::get_parser()` and dispatch it in `launch_mode()`.
+4. Add a `requirements.txt` in the tool's directory if it has extra dependencies.
+5. Write a `README.md` in the tool's directory following the style of the existing ones.
+
+---
+
+## Tool Documentation
+
+- [Config Tool](benchlab/config/README.md) — device configuration import/export
+- [Core](benchlab/core/README.md) — shared internals (data sources, process management, discovery)
+- [CSV Logger](benchlab/csv_log/README.md)
+- [FastAPI Server](benchlab/restapi/readme.md)
+- [Graph](benchlab/graph/README.md)
+- [HWiNFO Export](benchlab/hwinfo/README.md)
+- [Link](benchlab/link/README.md) — publish telemetry to BENCHLAB cloud
+- [MQTT Publisher](benchlab/mqtt/README.md)
+- [TUI](benchlab/tui/README.md)
+- [VU Dials](benchlab/vu/README.md)
+- [WigiDash](benchlab/wigidash/README.md)
+
+---
+
+## License
+
+Part of BENCHLAB PyTools. See main project license for details.