planir

Official Python SDK for planir.io — hosted, hardware-isolated microVM runtimes with a stable public URL per runtime. Sync and async clients.

Install

pip install planir

Usage

import os
from planir import PlanirClient

client = PlanirClient(token=os.environ["PLANIR_TOKEN"])

# List runtimes (one page; pass cursor=page.next_cursor for the next one)
page = client.runtimes.list()
for runtime in page.runtimes:
    print(runtime.id)

# Create a runtime
runtime = client.runtimes.create(request={"image": "ghcr.io/acme/agent:latest"})
print(runtime.urls)

The client defaults to https://api.planir.io; pass base_url to point elsewhere (e.g. a mock server in tests). An async client is available as AsyncPlanirClient. client.runtimes.runtime(runtime.id).commands and .pty expose the generated streaming Process client. Commands use argv; no shell is added implicitly. A custom httpx_client also requires process_http_client, because streaming Process calls use Connect's native Pyqwest client.

License

Apache-2.0