Skip to main content

TesterKit

PyPI Python License CI

Python hardware test platform for electronics validation and production.

TesterKit is a hardware test platform for test engineers. The main path is plain pytest — you write ordinary pytest functions and TesterKit handles the parts that aren't your test: instrument setup, limit checking, results storage, operator UI. Already running OpenHTF, LabVIEW, TestStand, or custom scripts? A results API records runs from any source, so you can adopt TesterKit without rewriting your suite. Tests run against mock instruments out of the box — start without hardware, move to a real bench later.

Get started in under a minute

pip install testerkit
testerkit init my_project --starter && cd my_project
pytest

The starter's test passes against mock instruments. The tutorial walks you from this starter project to a production-ready suite, one concept at a time.

Or explore it without installing: Open in GitHub Codespaces — a browser sandbox with mock instruments, the UI, analytics, and AI. Real instrument control needs a local install.

What --starter generated

# stations/starter_station.yaml — mock instruments for getting started
id: starter_station
name: Starter Station
instruments:
  psu:
    type: psu
    resource: "TCPIP::192.168.1.100::INSTR"
    mock: true
    mock_config:
      set_voltage: null
      enable_output: null
      measure_voltage: 5.0
  dmm:
    type: dmm
    resource: "TCPIP::192.168.1.101::INSTR"
    mock: true
    mock_config:
      measure_dc_voltage: 3.3
# tests/test_example.py
def test_output_voltage(context, psu, dmm, verify):
    """Verify output voltage is within spec."""
    vin = context.get_param("vin", 5.0)
    psu.set_voltage(vin)
    psu.enable_output()
    verify("output_voltage", float(dmm.measure_dc_voltage()))

psu and dmm come from your station config. context and verify come from the TesterKit plugin for pytest. No conftest.py needed.

Learning path

After the starter project runs, the recommended progression:

  1. Tutorial — Twelve short chapters from a first test through continuous production monitoring. Read in order; each builds on the last.
  2. Examples — A seven-step learning chain (01-vanilla07-profiles), each a diff off the last, plus standalone data-tier examples. Clone, run, modify.
  3. Concepts — Reference for the vocabulary: station, fixture, part, sequence, capability, vector.

When you're ready to leave mocks behind, Real Instruments covers the transition.

testerkit discover                 # scan for real instruments
testerkit station init             # assign roles interactively
testerkit new-test output_voltage  # scaffold a new test
pytest --mock-instruments       # develop without hardware
pytest --station=my_bench       # run against real instruments
testerkit runs                     # see results

Design principles

  1. Built for hardware test, end to end — Every measurement carries its limits, signal path, and the instrument that took it (with serial, cal date, firmware) — a field failure traces back to the exact bench state. Yield, Cpk, Pareto, retest, and time-loss analytics ship built in. Industry exporters (STDF, HDF5, TDMS, MDF4) bridge your reporting pipeline.
  2. Everything is a file you can version — Limits, stations, parts, fixtures, sequences, results — all files. Edit them in your text editor, diff them in git, review changes like code. A project moves between machines as a folder.
  3. Open and extensible, no lock-in — Pytest tests (plus its plugin ecosystem), PyVISA for any VISA-compatible instrument, YAML config, Parquet results that any data tool can read. All open source. If you change your mind about TesterKit, your tests, configs, and results travel with you.
  4. AI-ready, never AI-dependent — Built on technology AI assistants know deeply (pytest, YAML, Python, markdown). MCP tools expose every TesterKit operation; JSON Schemas act as guardrails for any config the AI writes. The platform itself never calls out to an AI model.
  5. Starts simple, grows with you — After install, pytest passes on any machine — no server, no account, no hardware needed to begin. Add what you need as you need it: measurement logging, station config, part specs, capability matching — in whatever order fits your project.

Project layout

parts/*.yaml           → Part characteristics and tolerances
catalog/*.yaml            → Instrument capabilities and accuracy
stations/*.yaml           → Which instruments are at this bench
fixtures/*.yaml           → How UUT pins connect to instruments
sequences/*.yaml          → What to test and in what order
tests/*.py                → Test code
data/*.parquet            → Measurements (run output, gitignored)

Your specs, stations, limits, and tests are all files — versioned in git. You get diffs on limit changes, code review on test sequences, and a history of every config change. (Run results land in data/, which stays out of git.)

verify() vs plain assert

Plain assert for pass/fail checks:

def test_power_on(psu):
    psu.enable_output()
    assert psu.get_status() == "ON"

verify() when you need recorded measurements:

def test_rail_3v3(context, psu, dmm, verify):
    psu.set_voltage(context.get_param("vin"))
    psu.enable_output()
    verify("rail_3v3", float(dmm.measure_dc_voltage()))
    # → limit-checked against the YAML next to the test or your part spec
    # → logged to your results file with the instrument that took it

Sweeps, limits, mocks, and retries are all controlled from a YAML file alongside the test — no extra wrapper code in your test function.

Capability matching

"We're bringing up a new board — do we have the instruments to test it?"

testerkit_match(requirements=[
    {"function": "dc_voltage", "direction": "input", "range_max": 50, "unit": "V"},
    {"function": "dc_current", "direction": "output", "range_max": 3, "unit": "A"},
])
# → Keysight 34461A covers dc_voltage input
# → Keysight E36312A covers dc_current output

TesterKit exposes this as an MCP tool, so an AI assistant can answer it directly from your catalog.

AI integration

Connect Claude Code or any AI assistant to your test system. Optional, not required.

testerkit setup claude-code    # Add to Claude Code
testerkit mcp serve            # Any MCP-compatible AI tool

An AI assistant can read a datasheet, extract specs, recommend instruments, generate configs, and scaffold tests for you to review.

CLI

testerkit init <name> [--starter]  # New project (--starter for full example)
testerkit discover [--visa]        # Scan for instruments
testerkit station init             # Interactive station setup
testerkit new-test <name>          # Scaffold a test file
testerkit serve [--reload]         # Operator UI
testerkit runs / show <id>         # Results
testerkit instrument list / show   # Instrument inventory
testerkit mcp serve                # MCP server
testerkit setup <tool>             # AI tool integration

Docs

License

Apache 2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

testerkit-0.4.0.tar.gz (3.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

testerkit-0.4.0-py3-none-any.whl (2.7 MB view details)

Uploaded Python 3

File details

Details for the file testerkit-0.4.0.tar.gz.

File metadata

  • Download URL: testerkit-0.4.0.tar.gz
  • Upload date:
  • Size: 3.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for testerkit-0.4.0.tar.gz
Algorithm Hash digest
SHA256 d66b50366dfd4568e0cd5ce26b6ba58d827e22e1c2e67648085120d03f593b24
MD5 c7df04deb0d8713707fd9ba8077b3fca
BLAKE2b-256 88b8a0e56a8540a70184273c35598cc2b4de7b0f811aaa4eb52f40ef5224446d

See more details on using hashes here.

Provenance

The following attestation bundles were made for testerkit-0.4.0.tar.gz:

Publisher: release.yml on pragmatest-dev/testerkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file testerkit-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: testerkit-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 2.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for testerkit-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a647e06e5477aca3aa5780102328b870ee225b1de2bde4232a7ba300bad3a8b2
MD5 9a14ea959c6b4081da01b44b1a33bd71
BLAKE2b-256 3cbb422b88664abe9f9474b64e05a4c5f6d3a1b52249d786e7a8f23aa869a742

See more details on using hashes here.

Provenance

The following attestation bundles were made for testerkit-0.4.0-py3-none-any.whl:

Publisher: release.yml on pragmatest-dev/testerkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page