kerf-sdk

Python SDK for Kerf — automate your CAD/EDA projects over HTTP/JSON-RPC.

Install

pip install kerf-sdk

Auth

Generate an API token from your workspace settings (/w/<slug>/settings → API Tokens), then:

export KERF_API_TOKEN=kerf_sk_...
export KERF_API_URL=https://kerf.sh   # default; omit for cloud

Quickstart

import kerf

k = kerf.from_env()

# list files in a project
files = k.files.list(project_id="<uuid>")
for f in files:
    print(f["name"], f["kind"])

# read a script file
content = k.files.read(project_id="<uuid>", file_id="<uuid>")

# search code across the project
results = k.files.search(project_id="<uuid>", query="extrude")

# read equations
eqs = k.equations.read(project_id="<uuid>", file_id="<uuid>")

API

All calls go through POST /v1/rpc as JSON-RPC 2.0 envelopes. The method names match Kerf's tool registry:

Low-level access

result = k.invoke("files.list", {"project_id": "..."})

Source

Part of the Kerf monorepo. SDK lives at kerf-sdk/.

License

MIT