arkitekt-spec
The wire format of an Arkitekt app: one definition of what an app is, shared by everything that produces or consumes it.
| Model | What it is | Produced by | Consumed by |
|---|---|---|---|
AppManifest, Requirement |
who the app is, which services it needs | arkitekt (from the App) |
kabinet |
Inspection |
what the app declares (rekuest's action language, carried as JSON) | arkitekt inspect all, inside the image |
arkitekt's plugin CLI, kabinet |
Selector (cpu, ram, cuda, rocm, oneapi, label) |
where a flavour may run | a flavour's config.yaml |
kabinet, deployers |
DeploymentsFile |
.arkitekt/deployments.yaml, the images a repo publishes |
arkitekt plugin publish |
kabinet's repo scan |
It also owns the action language (arkitekt_spec.actions: definitions, ports,
implementations) and the declaration layer (arkitekt_spec.declare): AppRegistry, the
@app.action / @app.workflow / @app.declare machinery, structures, and the Task protocol a
runtime implements. SDKs build on it; apps import the same names from
arkitekt. It depends on pydantic, pyyaml and three small
pure-python helpers, and on no runtime, transport or client.
Workflows and recovery
An implementation carries two claims the server keeps:
| Field | Values | Meaning |
|---|---|---|
execution |
PLAIN, WORKFLOW |
Only a WORKFLOW may call other actions; it is resumed when its agent dies, a PLAIN task ends LOST. |
effects |
NONE, REPEATABLE, UNKNOWN, IRREVERSIBLE |
What running it again would do. Information for whoever decides about a lost task, never a rule. |
code_hash pins a resume to the code that started the run. The errors a caller sees
(AgentLost, NonDeterministicWorkflow, NotAWorkflowError, StateChanged) live in
arkitekt_spec.declare.errors, and the workflow helpers (record, retry, hold, guard) are
on the Task protocol.
Compatibility
Every envelope model ignores unknown keys. An inspection is written by the arkitekt inside
an image and read by the host CLI, and deployments.yaml is written by the CLI and read by a
kabinet server that upgrades on its own schedule. Adding a field is therefore a minor change
an older reader survives. A change an older reader must refuse bumps spec_version.
Selectors are the exception: they refuse unknown keys, because they are written by hand and a typo must not silently widen a placement constraint.
from arkitekt_spec import load_deployments, dump_deployments
file = load_deployments(open(".arkitekt/deployments.yaml").read())
python -m arkitekt_spec prints the JSON Schema. The committed snapshot in
tests/fixtures/deployments.schema.json makes every format change show up in review.
1 maintainer
Metadata
1 maintainer
Release files for arkitekt-spec 3.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| arkitekt_spec-3.5.0.tar.gz | 180.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| arkitekt_spec-3.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 399.2 kB
Release files / arkitekt_spec-3.5.0.tar.gz
| Download URL | arkitekt_spec-3.5.0.tar.gz |
|---|---|
| Size | 180.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
88bd024d2ce2c9ba093c0f3adcf3435fa48278d186187fc550a4426c582450c3
|
|
BLAKE2b-256 checksum How to use checksums |
1b1303225d3e4f792260245c42f66bd7ff88a1d8a2019418b64f1a197b3ce480
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","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 / arkitekt_spec-3.5.0-py3-none-any.whl
| Download URL | arkitekt_spec-3.5.0-py3-none-any.whl |
|---|---|
| Size | 218.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1aed3f377b73b2ee4f88a17ea0007936a843c9cd9ae531919d7513ec044e1ffd
|
|
BLAKE2b-256 checksum How to use checksums |
e4fccce339c57dc8477fce86b3d9cbdd0603b0bcdc47123633f3e9c1377e08a6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","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}
|
