Skip to main content

labgrid-boardkit

Board manifests, boot strategies, pytest fixtures and test suites for labgrid.

Describe a board once in a board.yaml manifest, and labgrid-boardkit generates its labgrid client.yaml and drives it through a reusable boot strategy family:

Family Boots via
tftp U-Boot tftpboot (kernel, DTB, initramfs/FIT)
sdmux an SD card image written through a USB-SD-Mux
fastboot images flashed to eMMC/NOR over fastboot
qemu QEMU, no hardware needed

Install

pip install labgrid-boardkit

Usage

Lay out your boards as boards/<name>/board.yaml. Shared settings can go in a file listed under inherits:. For example (tests/fixtures/boards/ has one board per family, plus a shared families/ file and a variant):

name: example-qemu
yocto_machine: qemuriscv64
strategy: qemu
arch: riscv64
description: QEMU RISC-V virt machine, no hardware needed

boot:
  bootargs: root=/dev/vda rw console=ttyS0

qemu:
  binary: qemu-system-riscv64
  machine: virt
  cpu: rv64
  memory: 2048
  ssh_port: 2222
  telnet_port: 2323

images:
  bios: /srv/images/example-qemu/fw_jump.elf
  kernel: /srv/images/example-qemu/Image
  ext4: /srv/images/example-qemu/rootfs.ext4

shell:
  username: root

From the directory that contains boards/:

boardkit-validate          # check every boards/*/board.yaml against the schema
boardkit-render            # write each board's client.yaml/env.yaml and boards/machines.tsv
boardkit-render --check    # exit 1 if any rendered file is out of date (for CI)

Installing the package also registers a pytest plugin. It picks --lg-env from $BOARD or the nearest client.yaml, and provides the tftp, sd and fastboot fixtures. Generic on-target suites ship with the package:

BOARD=boards/my-board pytest --pyargs labgrid_boardkit.tests
pytest --lg-env boards/example-qemu/env.yaml --pyargs labgrid_boardkit.ptest

Adding a strategy family

Families are found through the labgrid_boardkit.strategies entry-point group, so another package can add one without changing this one:

[project.entry-points."labgrid_boardkit.strategies"]
myfamily = "my_package.strategies:MyBootStrategy"

Development

uv run pytest
uv run ruff check . && uv run ruff format --check .

Metadata

Release files for labgrid-boardkit 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for labgrid-boardkit 0.1.0
File Size Uploaded Provenance Actions
labgrid_boardkit-0.1.0.tar.gz 17.3 kB Without provenance Details for labgrid_boardkit-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for labgrid-boardkit 0.1.0
File Interpreter ABI Platform Actions
labgrid_boardkit-0.1.0-py3-none-any.whl Python 3 none any Details for labgrid_boardkit-0.1.0-py3-none-any.whl

Total release size: 43.1 kB

Release files / labgrid_boardkit-0.1.0.tar.gz

Download URL labgrid_boardkit-0.1.0.tar.gz
Size 17.3 kB
Tags Source
SHA-256 checksum
How to use checksums
b8afd3e992129ad3922bfb8d073b995262d1eac2375ca21e3b73adf0158def6a
BLAKE2b-256 checksum
How to use checksums
7b6d3ddee5bfcf2b269e5c9116186c0aa110ccff763f7555efe2693be8906411
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / labgrid_boardkit-0.1.0-py3-none-any.whl

Download URL labgrid_boardkit-0.1.0-py3-none-any.whl
Size 25.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8a29674209cd29fa0c801e23e04298b3dcb9574f899750f45c3cbedd6c355ed4
BLAKE2b-256 checksum
How to use checksums
2dc57667f8c4bbbe92cd71e740dcb1df1b882c2f3ccf2eba209f28e8fbc756d2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for labgrid-boardkit 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

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