benchloom 0.1.3__tar.gz

benchloom-0.1.3/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,41 @@
+name: Bug report
+description: Something does not work as it should.
+labels: [bug]
+body:
+  - type: textarea
+    id: what
+    attributes:
+      label: What happened?
+      description: What you did, what you expected, and what happened instead.
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: How to make it happen again
+      description: Steps, or a small project (zip the project folder without its runs/).
+  - type: textarea
+    id: log
+    attributes:
+      label: Console output
+      description: From the Console, or the run folder's console.log. Error messages are most helpful.
+      render: text
+  - type: input
+    id: version
+    attributes:
+      label: Benchloom version
+      description: "`pip show benchloom`, or the version at the top of a run's report.html"
+    validations:
+      required: true
+  - type: input
+    id: system
+    attributes:
+      label: Operating system and Python version
+      placeholder: Windows 11, Python 3.12
+    validations:
+      required: true
+  - type: input
+    id: instruments
+    attributes:
+      label: Instruments involved
+      description: Model, and how it is connected (serial, USB, GPIB adapter, LAN).

benchloom-0.1.3/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Security problem
+    url: https://github.com/criscrafter/benchloom/security/advisories/new
+    about: Please report security problems privately, not as a public issue.

benchloom-0.1.3/.github/ISSUE_TEMPLATE/instrument_request.yml

@@ -0,0 +1,35 @@
+name: Instrument request
+description: Ask for support of an instrument Benchloom does not have a driver for.
+labels: [instrument]
+body:
+  - type: input
+    id: model
+    attributes:
+      label: Instrument
+      placeholder: Maker and model, for example Rigol DP832
+    validations:
+      required: true
+  - type: dropdown
+    id: connection
+    attributes:
+      label: How it connects
+      multiple: true
+      options: [USB (serial / virtual COM port), USB (other), RS-232 / RS-485, GPIB, LAN, Other]
+    validations:
+      required: true
+  - type: input
+    id: manual
+    attributes:
+      label: Programming manual
+      description: A link to the command reference, if you have one.
+  - type: textarea
+    id: use
+    attributes:
+      label: What do you want to do with it?
+      description: The commands that matter most to you, for example set voltage, measure current.
+  - type: checkboxes
+    id: help
+    attributes:
+      label: Can you help test?
+      options:
+        - label: I own this instrument and can try a driver on it.

benchloom-0.1.3/.github/pull_request_template.md

@@ -0,0 +1,16 @@
+## What this changes
+
+<!-- What and why, in a few sentences. Link the issue if there is one. -->
+
+## How it was tested
+
+<!-- Tests added or run; for a driver: which instrument, firmware and connection,
+     or "simulator only". -->
+
+## Checklist
+
+- [ ] `pytest` passes.
+- [ ] New instrument drivers come with a simulator and tests, and notes in
+      `docs/INSTRUMENTS.md` on what was tried on real hardware.
+- [ ] I have read and agree to the [Benchloom Contributor License Agreement](../CLA.md).
+      <!-- Not needed for typo or wording fixes. -->

benchloom-0.1.3/.github/workflows/release.yml

@@ -0,0 +1,83 @@
+name: Release
+
+# Builds Benchloom-<version>-windows-x64.zip, runs its self-test and publishes it.
+# For a pushed version tag (v1.2.3) it creates the release itself, with notes from
+# the version's section in CHANGELOG.md, so nothing needs editing by hand, and then
+# uploads the Python package to PyPI. Run by hand (Actions -> Release ->
+# Run workflow), it only re-attaches the zip to an existing release.
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Release tag to attach the download to, for example v0.1.0"
+        required: true
+
+permissions:
+  contents: write  # to upload the zip to the release
+
+jobs:
+  build:
+    runs-on: windows-latest
+    env:
+      TAG: ${{ github.event.inputs.tag || github.ref_name }}
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          ref: ${{ env.TAG }}
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[gui,usb]" "pyinstaller>=6.10"
+
+      - name: Build and self-test
+        run: python packaging/build_windows.py
+
+      - name: Publish the release
+        shell: bash
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          if gh release view "$TAG" > /dev/null 2>&1; then
+            gh release upload "$TAG" build/Benchloom-*-windows-x64.zip --clobber
+          else
+            python packaging/release_notes.py "$TAG" > notes.md
+            gh release create "$TAG" build/Benchloom-*-windows-x64.zip \
+              --title "Benchloom ${TAG#v}" --notes-file notes.md --verify-tag --latest
+          fi
+
+  pypi:
+    # PyPI trusts this workflow ("trusted publishing"), so no password or token is
+    # stored anywhere. Only after the Windows build passed its self-test.
+    needs: build
+    if: github.event_name == 'push'
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/benchloom/
+    permissions:
+      id-token: write  # proves to PyPI that this is criscrafter/benchloom's workflow
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          ref: ${{ github.ref_name }}
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Build the package
+        run: |
+          python -m pip install --upgrade build twine
+          python -m build
+          python -m twine check --strict dist/*
+          test "$(ls dist/*.whl)" = "dist/benchloom-${GITHUB_REF_NAME#v}-py3-none-any.whl"
+
+      - name: Upload to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

benchloom-0.1.3/.github/workflows/tests.yml

@@ -0,0 +1,42 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: ${{ matrix.os }} · Python ${{ matrix.python }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, ubuntu-latest]
+        python: ["3.11", "3.13"]
+    env:
+      QT_QPA_PLATFORM: offscreen
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Qt's system libraries (Linux)
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libegl1 libgl1 libxkbcommon0 libdbus-1-3 \
+            libfontconfig1 libglib2.0-0 fonts-dejavu-core
+
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[gui,usb,dev]"
+
+      - name: Test
+        run: pytest -q

benchloom-0.1.3/.gitignore

@@ -0,0 +1,9 @@
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+runs/
+packaging/version_info.txt

benchloom-0.1.3/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+## 0.1.3 – Safer stops, plugin consent and PyPI
+
+- **Plugins in a project need your consent:** a project's own `plugins/` folder
+  is Python code, and it used to be loaded as soon as the project was opened.
+  Now the app asks first, per project, and `benchloom run` needs
+  `--trust-plugins` once. Until then such a plugin does not replace a built-in
+  one either.
+- **Stopping switches outputs off more reliably:** when a script does not stop
+  within 3 s (a loop that never checks, a slow command), the run now shuts its
+  devices down without the script instead of being killed with the outputs on.
+  Shutting down is no longer cut short after 3 s, and closing the window
+  while a test runs waits for it too.
+- The app no longer shows the commands of another project's plugin after
+  switching between projects that carry a plugin with the same id.
+- **On PyPI:** `pip install "benchloom[gui,usb]"` installs Benchloom; every
+  release is uploaded there automatically.
+
+## 0.1.2 – Lua sandbox
+
+- **Lua sandbox:** scripts no longer reach files, other programs or other code
+  on the computer (`io`, `os.execute` and the rest of `os` except `time`,
+  `clock`, `date` and `difftime`, `require`, `dofile`, `loadfile`, `package`,
+  `debug`, `collectgarbage`, `string.dump`; `load` takes text only), and use at
+  most 1 GB of memory. Scripts that read or wrote files themselves need
+  changing.
+- CONTRIBUTING: the build command for the Windows download was garbled.
+
+## 0.1.1 – Windows download
+
+- **Windows download:** `Benchloom-0.1.1-windows-x64.zip` on the releases page.
+  Unzip and start `Benchloom.exe`; no Python needed. `benchloom-cli.exe` is the
+  command line.
+- The app has an About dialog and `benchloom --version` with the licence and
+  warranty notices.
+- Waveform PNGs also work in the packaged app, and show text when Qt runs
+  offscreen on Windows.
+- CI runs on Windows and Linux; the Linux test run no longer fails after the
+  tests have passed (a PySide6 shutdown fault).
+
+## 0.1.0 – first public release
+
+Benchloom was developed as "Patchbay" until this release. Projects with a
+`patchbay.toml`, the `~/.patchbay` folder and the desktop app's settings from
+that time keep working.
+
+- **Tests** as Lua scripts or as visual graphs (nodes and wires, compiled to
+  Lua), run in a separate process that can always be stopped.
+- **Desktop app:** project wizard with templates, device manager with serial
+  port list and connection test, Lua editor, node editor (undo/redo,
+  copy/paste), live plot (right-hand scale, log X, column choice), front panel
+  with controls and indicators, waveform viewer, plugin manager, settings,
+  light and dark theme.
+- **Run folders** with `data.csv`, console log, `run.json`, a copy of the
+  script, pass/fail checks (`check`), saved waveforms (`save_waveform`, as CSV,
+  SVG and PNG) and `report.html` with the verdict, data chart and waveforms.
+- **Instruments:** Kunkin KP184 electronic load (RS-232 and RS-485), Chroma 6404
+  AC source, Hantek DSO5102P oscilloscope (USB, including gain/phase
+  measurement), Feeltech FY6900 function generator (signal, modulation, sweep,
+  counter), HP 6655A, HP 3478A and HP 53131A (GPIB, from their manuals), a
+  generic SCPI driver and an Arduino line protocol. Each has a simulator.
+- **Connections:** serial, TCP, Prologix and AR488 GPIB adapters, VISA, USB
+  bulk and USBTMC (including the xyphro UsbGpib adapter) without a vendor VISA.
+- **Templates:** a power supply example and a Bode plot (FY6900 and DSO5102P)
+  that finds the -3 dB points and can check them against limits.
+- **Plugins:** installable from a folder or a .zip, can be switched off,
+  `benchloom plugins` on the command line.

benchloom-0.1.3/CLA.md

@@ -0,0 +1,38 @@
+# Benchloom Contributor License Agreement
+
+Version 1.0
+
+This agreement is between you (the contributor) and the maintainer of
+Benchloom, Friedrich-Christer Rosenthal (the maintainer). It covers everything
+you submit to the Benchloom project, such as code, documentation and drivers
+(your contributions).
+
+1. **You keep your copyright.** You do not transfer ownership of your
+   contributions.
+
+2. **Licence to the maintainer.** You grant the maintainer, and anyone the
+   maintainer licenses Benchloom to, a perpetual, worldwide, non-exclusive,
+   royalty-free, irrevocable licence to use, copy, modify, publish, distribute
+   and sublicense your contributions, under the GNU Affero General Public
+   License or **any other licence, including commercial licences**.
+
+3. **Patents.** You grant the same parties a perpetual, worldwide,
+   non-exclusive, royalty-free, irrevocable licence under any patents you hold
+   that your contributions would otherwise infringe, to make, use, sell and
+   distribute them as part of Benchloom.
+
+4. **Open source stays open.** The maintainer will keep making your
+   contributions available under the GNU Affero General Public License 3.0 or a
+   later version, as part of Benchloom.
+
+5. **You may agree to this.** Your contributions are your own work, or you have
+   the right to submit them under these terms. If your employer has rights in
+   your work, you have its permission or it has waived those rights. You say
+   so when parts of a contribution come from someone else, along with their
+   licence.
+
+6. **No warranty.** Your contributions are provided "as is", without warranty
+   of any kind, and you are not expected to support them.
+
+You agree to this by ticking the box in the pull request template, or by
+writing "I agree to the Benchloom CLA" in the pull request.

benchloom-0.1.3/CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Contributing to Benchloom
+
+Thank you for helping. Bug reports, instrument drivers, fixes and documentation
+are all welcome.
+
+## Reporting a bug or asking for an instrument
+
+Open an issue and pick a template. For a bug, say what you did, what you
+expected and what happened, and attach the run folder's `console.log` (and
+`run.json`) if a test run went wrong. For an instrument, name the model, how it
+connects (serial, USB, GPIB, LAN) and link its programming manual if you have
+it.
+
+## Setting up
+
+```
+git clone https://github.com/criscrafter/benchloom
+cd benchloom
+python -m venv .venv
+.venv\Scripts\pip install -e ".[gui,dev]"      # Linux/Mac: .venv/bin/pip
+.venv\Scripts\pytest
+```
+
+Python 3.11 or newer. The tests use the instruments' simulators, so no hardware
+is needed; the desktop app is tested offscreen.
+
+## Building the Windows download
+
+```
+.venv\Scripts\pip install -e ".[gui,usb]" pyinstaller
+.venv\Scripts\python packaging\build_windows.py
+```
+
+This makes `build/Benchloom-<version>-windows-x64.zip` and runs a self-test of
+the packaged app first.
+
+To release a version: add its section to CHANGELOG.md (`## 1.2.3 – title`),
+set `__version__` in `src/benchloom/__init__.py`, and push the tag `v1.2.3`.
+GitHub then builds and self-tests the download and publishes the release with
+that changelog section as its notes, then uploads the package to PyPI;
+nothing needs editing by hand. PyPI accepts it through trusted publishing
+(the `pypi` environment of this repository), so no token is stored anywhere.
+
+## Writing an instrument plugin
+
+A plugin is a folder with a `plugin.toml` and a Python driver. The README
+section "A plugin" shows the format, and `src/benchloom/plugins/demo` is the
+reference example. For a driver to be merged it needs:
+
+- **A simulator** that answers like the real instrument (`simulator = ...` in
+  `plugin.toml`), so the driver is tested without hardware, and tests in
+  `tests/` that use it.
+- **Output safety:** sources and loads switch their output off in `close()`
+  unless the device entry says `leave_output_on = true`.
+- **Honest notes** in `docs/INSTRUMENTS.md`: what was tried on real hardware
+  (model, firmware, connection) and what was only written from the manual.
+- **Checked settings:** when an instrument silently clamps or ignores a value,
+  read it back and raise a `CommandError` that says what happened.
+
+## Code style
+
+- Readable over clever; comments say why, not what.
+- Error messages tell the user what to do ("is the channel on and the scope
+  running?"), in plain words.
+- New files start with the licence header:
+  ```
+  # SPDX-License-Identifier: AGPL-3.0-or-later
+  # Copyright (C) 2026 <your name>
+  ```
+- Run `pytest` before you open a pull request. CI runs it on Windows and Linux.
+
+## The contributor agreement
+
+Benchloom is open source under the AGPL-3.0, and the maintainer also offers
+commercial licences to companies that cannot use the AGPL. That only works if
+the maintainer may license every part of Benchloom, including contributions,
+on both terms.
+
+So every pull request needs agreement to the **[Contributor License
+Agreement](CLA.md)**: you keep the copyright of your contribution and grant a
+licence to use it, including under other licences. Tick the box in the pull
+request template to agree. Your contribution stays available under the AGPL in
+any case.
+
+Small fixes of typos or wording need no agreement.