Skip to content

Development

Two pages. Read both before your first change — the second one is the part that is not visible from the code.

In this section

  •   Dev setup

    uv sync, make check, what CI runs, and the repo’s one structural trap: the host scripts have no .py extension, so ruff and pyrefly only see them through explicit include lists.

  •   Invariants

    Eleven things that will break if you change them casually — script names, the read-only mount, the capital-G scope, the deliberate race ordering, and more.

Ground rules

  • Branch from develop.
  • This is not a distributable package. No wheel, no npm package, no registry image. pyproject.toml exists only to configure pytest/ruff/pyrefly and is marked [tool.uv] package = false.
  • Host scripts are stdlib-only. gen_clab_topology, gen_device_configs, run_workflow, wait_ready and wait_devices run on a bare host before any virtualenv exists. Do not add a third-party import to them.
  • Never commit generated/. It is rebuilt from topology.json on every lab bring-up, and containerlab mints TLS private keys in there.
  • make test is the meaningful gate for generator changes — fast, hermetic, and it is what catches an uncommitted parameter-file regeneration.

Package naming

Thing Package Lives in
Lab-local function blocks fb.lab.neops.io this repo, function_blocks/ (currently empty)
Lab workflows wf.lab.neops.io this repo, workflows/
The discovery function block fb.base.neops.io neops-worker-sdk-py, shipped in the worker image