Skip to main content

isb for Python

An asyncio SDK for isb: declarative incus sandboxes (containers and VMs). It is a thin client of isb rpc, a line-delimited JSON protocol over the isb binary's stdin and stdout (docs/reference/rpc.md). All the work (planning, reconciling, readiness, exec) happens in isb; this package starts it, sends requests and maps the answers to Python types.

  • Python 3.10 or later, Linux.
  • No runtime dependencies (standard library only).
  • Typed (py.typed), with TypedDicts for the spec generated from isb schema.

Install

pip install isb-sdk

Platform wheels (x86_64 and aarch64 Linux, Apple silicon and Intel macOS) bundle the isb binary at isb/_bin/isb, so nothing else is needed. It is the release's signed binary, checked against the release signature when the wheel is built; pip itself checks only PyPI's hashes. The pure wheel and the sdist bundle none; they use an isb binary from elsewhere. To use the isb you installed with the installer instead, set ISB_BIN=$(command -v isb).

The binary is looked up in this order:

  1. Client(isb_bin="/path/to/isb")
  2. the ISB_BIN environment variable
  3. the bundled binary
  4. isb on PATH

It must be a version with the rpc command (protocol 1). The client refuses a server that announces any other protocol version.

isb needs access to the incus socket ($INCUS_SOCKET, else $INCUS_DIR/unix.socket, else /var/lib/incus/unix.socket), which usually means membership in incus-admin. That access is root-equivalent on the host.

Quickstart

import asyncio
import isb
from isb import PortBinding, Sandbox, Volume


async def main() -> None:
    async with isb.Client() as client:
        sb = await Sandbox.connect_or_create(
            "dev-web",
            image="dev-base",
            client=client,
            cpus=4,
            mem_limit="4g",
            idmap="auto",
            labels={"app": "web"},
            environment={"NODE_ENV": "development"},
            volumes=[
                Volume.bind("./src", "/home/dev/src", device="src"),
                Volume.named("dev-cache", "/home/dev/.cache", owner="dev"),
            ],
            ports=[
                PortBinding.publish("5173-5193", 5173, name="vite"),  # first free port
                "8080:80",  # docker's short syntax works too
            ],
            ready=["running", "default_route", {"user_exists": "dev"}],
            user="dev",
            working_dir="/home/dev/src",
            on_progress=print,
        )
        print(sb.last_report)

        # Captured output. argv is never joined into a shell string.
        out = await sb.exec("printf", ["[%s]", "a b", "$HOME"])
        assert out.stdout_text == "[a b][$HOME]"

        # Streaming output, as it is produced.
        script = "for i in 1 2 3; do echo $i; sleep 1; done"
        proc = await sb.exec_stream(["sh", "-c", script])
        async with proc:
            async for event in proc:
                print(event.kind, event.text, end="")
            print("exit code:", await proc.wait())

        await sb.remove(force=True)


asyncio.run(main())

Compose files

project = await isb.Project.load("isb.yaml", vars={"WORKTREE": "/srv/wt"})

for plan in await project.plan():
    print(plan.name, plan.status, plan.actions)

# Like `isb up -d`: returns once the sandboxes are ready. A service's
# `command` is for the foreground CLI `isb up` and is not run here.
for service, report in await project.up(on_progress=print):
    print(service, report.created, report.ports)

# A sandbox from the project carries its service's exec defaults.
web = project.sandbox("web")
await web.exec(["bun", "install"])

await project.down(volumes=True)

API overview

Client

Client(isb_bin=None, socket=None, project=None, create_timeout=None) owns one isb rpc subprocess, started on first use (or await client.start()) and stopped by await client.close() or async with. socket, project and create_timeout are passed as the global flags --socket, --project and --create-timeout. Requests run concurrently over the one process.

Every function takes an optional client=. Without one it uses isb.default_client(), created lazily with default settings (one per event loop). client.call(method, params) sends any protocol method directly.

A client belongs to the event loop it started on. If the subprocess exits, every pending and later request fails with ProcessError, whose message includes the tail of isb's stderr.

The server's working directory is fixed when it starts, so the SDK resolves relative paths itself: base_dir for bind mounts defaults to the current directory at the time of the call, and compose file paths are made absolute.

Sandbox

await Sandbox.create(name, *, image, **spec) Create. AlreadyExistsError if the name is taken.
await Sandbox.connect_or_create(name, *, image, prune_devices=False, **spec) Create or reconcile (only what differs changes). The report is on sb.last_report. Also Sandbox.ensure.
await Sandbox.plan(name, *, image, **spec) What connect_or_create would do, as a Plan.
await Sandbox.get(name) Handle on an existing sandbox. NotFoundError if missing.
await Sandbox.list_with(labels) / Sandbox.list() list[SandboxInfo]. labels is {"k": "v", "k2": None} or ["k=v", "k2"].
await Sandbox.remove(name, force=False) Delete. A running sandbox needs force.

name is the incus instance name (the spec's container_name). **spec are the fields of a compose service (docs/reference/compose.md), named as in docker compose: cpus (a count) or cpuset ("0-3"), mem_limit ("512m", "8g", "8GiB"), storage, type ("container", "virtual-machine" or "vm"), privileged, idmap, incus_profiles, labels and environment (a map or a ["KEY=VALUE"] list), volumes and ports (lists; see Builders), user, working_dir, exec (env for exec only, login), command (a string or argv), ready, ready_timeout, raw_config, raw_devices. A full spec dict can be passed as spec= instead. The server rejects unknown fields (InvalidError). The create-style methods also take base_dir, wait_ready (default true), named_volumes and on_progress (called with each progress line). named_volumes are top-level volume definitions, as in a compose file's volumes:: a mount's source names a key, and the incus volume is that definition's name, else the key itself.

On an instance: info(), labels(), start(), stop(force=False, timeout="30s"), restart(), wait_ready(ready=None, ready_timeout=None), remove(force=False), add_port(port) (a ports entry; returns the listen address in use), remove_device(name) (returns whether it existed).

A handle from create, connect_or_create or Project.sandbox carries the exec defaults its spec implies (user, working_dir, exec.env, exec.login) as sb.exec_defaults (an ExecDefaults dict of user, cwd, env, login) and sends them with every exec; per-call arguments override them.

Exec

out = await sb.exec(
    cmd,
    args=None,
    *,
    cwd=None,
    user=None,
    env=None,
    login=None,
    timeout=None,
    stdin=None,
    tty=False,
)

cmd is a program plus args, or a full argv list. Returns ExecOutput(exit_code, stdout: bytes, stderr: bytes) with stdout_text, stderr_text and success. A non-zero exit is not an exception. stdin is bytes or str, sent followed by EOF. timeout is seconds or a duration string ("90s"); when it passes, the command is killed and IsbTimeoutError is raised. With tty=True, all output arrives as stdout.

p = await sb.exec_stream(cmd, args=None, *, ..., stdin=None | "piped" | bytes)

returns an ExecProcess: iterate it for ExecEvent(kind, data) chunks in order, and drive it with await p.write(b), await p.close_stdin(), await p.signal(15), await p.resize(w, h). await p.wait() returns the exit code, await p.collect() gathers the rest into an ExecOutput. Used as async with, it kills the command on exit if it is still running.

Builders

These return plain dicts, one volumes or ports list entry each. Docker's short strings work in the same lists: "./src:/home/dev/src:ro" (options ro, rw, owner=USER, device=NAME, pool=POOL, external; a source starting with /, . or ~ is a host path, anything else a named volume) and "[HOST_IP:]PUBLISHED:TARGET[/udp]" (HOST_IP defaults to 127.0.0.1).

  • Volume.bind(source, target, *, read_only=False, device=None, options=None): bind-mount a host path.
  • Volume.named(source, target, *, external=False, owner=None, read_only=False, pool=None, device=None, options=None): mount a named volume, created if missing unless external; owner chowns the mount point.
  • PortBinding.publish(published, target, *, host_ip=None, protocol=None, name=None, options=None): publish a guest port on the host. A published range ("5173-5223") with one target takes the first free port; ApplyReport.ports says which.
  • PortBinding.host(listen, connect, *, name=None, search=None, options=None): an incus proxy listening on the host, connecting in the guest, for addresses publish cannot express (unix: sockets, a connect host). search=N turns a single listen port P into the published range P-(P+N), so it needs a single TCP/UDP listen port and a connect port with no host of its own (ValueError otherwise).
  • PortBinding.guest(listen, connect, *, name=None, options=None): listen in the guest, connect on the host.

Project

await Project.load(files=None, *, env_files=None, project_name=None, vars=None) loads and resolves compose files (default ./isb.yaml, else ./isb.yml, plus ./isb.override.yaml when present). A .env next to the first file is read unless env_files is given. vars win over the environment for ${VAR}. The result has name, base_dir, files, file (the resolved file, every service's container_name filled in) and services. Then up(services=None, *, prune_devices=False, wait_ready=True) returns (service, ApplyReport) pairs, plan(...) returns list[Plan], down(services=None, *, volumes=False) deletes, and sandbox("web") returns a handle with that service's exec defaults.

Volumes and prune

isb.volumes.list(pool=None), get(name, pool=None), create(name, pool=None, *, config=None) (returns {"created", "pool"}, a no-op if it exists), remove(name, pool=None). isb.Volumes(client) has the same methods bound to one client. await isb.prune(label, dry_run=True) lists (or, with dry_run=False, deletes) sandboxes whose label value is a host path that no longer exists.

Types

SandboxInfo, ApplyReport, Plan, VolumeInfo, PruneResult, ExecOutput and ExecEvent are dataclasses. Plan actions are dicts tagged by action. The spec types (ComposeFile, SandboxSpec, VolumeSpec = str | VolumeMount, PortSpec = str | PortMapping | ProxyPort, ExecSpec, ReadyCheck, IdmapSpec, NamedVolumeSpec, MapOrList, Command) are TypedDicts and aliases in isb._spec, generated from the JSON Schema by scripts/gen_types.py. ExecDefaults is the exec-defaults dict of the protocol.

ISB_BIN=/path/to/isb python3 scripts/gen_types.py          # regenerate
ISB_BIN=/path/to/isb python3 scripts/gen_types.py --check  # fail if stale

Errors

Every error is an IsbError with code (the protocol's stable code), message and data:

class codes
NotFoundError not_found
AlreadyExistsError already_exists
NotReadyError not_ready
IsbTimeoutError request_timeout, operation_timeout, exec_timeout
InvalidError invalid, interpolation, parse
ConnectError connect (isb cannot reach incusd)
ApiError api, operation_failed
ProtocolError protocol (also unknown method), bad_request, a bad hello
ProcessError process: the subprocess could not start or exited
BinaryNotFoundError binary_not_found (a ProcessError)

Other codes (websocket, io, json) raise IsbError itself. IsbTimeoutError does not derive from the built-in TimeoutError.

Development

Unit tests need only an isb binary with rpc (they use a socket that does not exist, and fake servers for failure paths); integration tests need incusd and a local image with a dev user at uid 1000 and python3 (ISB_TEST_IMAGE, default dev-base). Both use the standard library's unittest, so no install is needed:

# from the repository root
cargo build
ISB_BIN=target/debug/isb PYTHONPATH=sdk/python/src python3 -m unittest discover -s sdk/python/tests -v
ISB_INTEGRATION=1 ISB_BIN=target/debug/isb PYTHONPATH=sdk/python/src python3 -m unittest discover -s sdk/python/tests -v

Integration tests name everything isb-test-py-<pid>-..., label it isb-test=py, and remove it afterwards.

Lint, type check and build (in sdk/python):

uv sync --group dev
uv run ruff check . && uv run ruff format --check .
uv run mypy
uv build                                      # pure wheel and sdist
ISB_WHEEL_BINARY=../../target/x86_64-unknown-linux-musl/release/isb \
ISB_WHEEL_PLAT=manylinux_2_17_x86_64.musllinux_1_2_x86_64 \
uv build --wheel                              # platform wheel with the binary

License

MIT

Metadata

Release files for isb-sdk 3.4.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 isb-sdk 3.4.0
File Size Uploaded Provenance Actions
isb_sdk-3.4.0.tar.gz 44.0 kB Without provenance Details for isb_sdk-3.4.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for isb-sdk 3.4.0
File Actions
isb_sdk-3.4.0-py3-none-manylinux_2_17_x86_64.musllinux_1_2_x86_64.whl Python 3 none Linux glibc 2.17+ x86-64, Linux musl 1.2+ x86-64 Details for isb_sdk-3.4.0-py3-none-manylinux_2_17_x86_64.musllinux_1_2_x86_64.whl
isb_sdk-3.4.0-py3-none-manylinux_2_17_aarch64.musllinux_1_2_aarch64.whl Python 3 none Linux glibc 2.17+ ARM64, Linux musl 1.2+ ARM64 Details for isb_sdk-3.4.0-py3-none-manylinux_2_17_aarch64.musllinux_1_2_aarch64.whl
isb_sdk-3.4.0-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details for isb_sdk-3.4.0-py3-none-macosx_11_0_arm64.whl
isb_sdk-3.4.0-py3-none-macosx_10_12_x86_64.whl Python 3 none macOS 10.12+ x86-64 Details for isb_sdk-3.4.0-py3-none-macosx_10_12_x86_64.whl
isb_sdk-3.4.0-py3-none-any.whl Python 3 none any Details for isb_sdk-3.4.0-py3-none-any.whl

Total release size: 41.7 MB

Release files / isb_sdk-3.4.0.tar.gz

Download URL isb_sdk-3.4.0.tar.gz
Size 44.0 kB
Tags Source
SHA-256 checksum
How to use checksums
4e0a84165ad7dc51c0284ba25cba2fc33625f6328d0de45ccbcc8043725edd5e
BLAKE2b-256 checksum
How to use checksums
11af2e9a5db5428d0671bc5183318d2240cf298e9d072ed708f1426b04f9d363
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / isb_sdk-3.4.0-py3-none-manylinux_2_17_x86_64.musllinux_1_2_x86_64.whl

Download URL isb_sdk-3.4.0-py3-none-manylinux_2_17_x86_64.musllinux_1_2_x86_64.whl
Size 14.7 MB
Tags Linux glibc 2.17+ x86-64 Linux musl 1.2+ x86-64 Python 3
SHA-256 checksum
How to use checksums
26caebeacf9bd92c7b030e96e24bc9a155a22f65859ae752c0f3b76abc01df1e
BLAKE2b-256 checksum
How to use checksums
ff7aaaf2185668a8876d71068561a8c8278db945d748e03a5697ee070013282b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / isb_sdk-3.4.0-py3-none-manylinux_2_17_aarch64.musllinux_1_2_aarch64.whl

Download URL isb_sdk-3.4.0-py3-none-manylinux_2_17_aarch64.musllinux_1_2_aarch64.whl
Size 13.9 MB
Tags Linux glibc 2.17+ ARM64 Linux musl 1.2+ ARM64 Python 3
SHA-256 checksum
How to use checksums
b7ac011940d6b4c684786966a984bb934ec09b750afaa6c53f0f086db6d47293
BLAKE2b-256 checksum
How to use checksums
8d688af4d3367406f41c6bfefa7de1e6acde045a654618d95dda472b210a15fa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / isb_sdk-3.4.0-py3-none-macosx_11_0_arm64.whl

Download URL isb_sdk-3.4.0-py3-none-macosx_11_0_arm64.whl
Size 6.3 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
687f9f7da470e67421e24b17c2f72da471d8299289216135f0468ae8d1c13e52
BLAKE2b-256 checksum
How to use checksums
eb322779efdbd47117f63e85d88992c986898a651c02bb1ec8943af21f896dad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / isb_sdk-3.4.0-py3-none-macosx_10_12_x86_64.whl

Download URL isb_sdk-3.4.0-py3-none-macosx_10_12_x86_64.whl
Size 6.7 MB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
dd5a0b5594fa8d160943e2e714a4a5645781157bb0e39bc60d0cfef9bb641bc2
BLAKE2b-256 checksum
How to use checksums
718127d0440d62481fd50912568ac0208a6eb8a77ddd3a09ae6219112986e710
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / isb_sdk-3.4.0-py3-none-any.whl

Download URL isb_sdk-3.4.0-py3-none-any.whl
Size 37.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e16825e67f55d1669ee6de0719d2c656b908740323c5e3b26cfa4296adcac0d5
BLAKE2b-256 checksum
How to use checksums
de38768564ff4218414fb3fad8c1eb70a6f674bc9a1ae654a5381526a71ba33a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for isb-sdk 3.4.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

3.4.0 This release

6 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