Metadata-Version: 2.4
Name: armnet-runtime
Version: 0.1.0
Summary: armnet runtime SDK — used by code running inside customer containers on a cell.
Project-URL: Homepage, https://armnet.dev
Project-URL: Documentation, https://safe-robotics.github.io/alpha-robotics/packages/runtime/
Author: Ville Kuosmanen
License: Apache-2.0
Requires-Python: <3.13,>=3.12
Requires-Dist: armnet-core>=0.1.0
Requires-Dist: protobuf<7,>=5
Requires-Dist: pydantic<3,>=2.6
Provides-Extra: dev
Requires-Dist: pytest>=8; extra == 'dev'
Description-Content-Type: text/markdown

# armnet-runtime

The runtime SDK for the [Armnet](https://armnet.dev) managed arm farm — the
package you install **inside your container image**. It provides the `@main`
decorator, the `Context` your function receives, and the `armnet-runtime`
console script the container runs. It has a deliberately tiny dependency
footprint so it's cheap to bake into every image.

```python
from armnet_runtime import Context, main

@main
def run(ctx: Context) -> dict:
    ctx.report_progress("starting")
    obs = ctx.cell.get_observation()
    ...
    return {"ok": True}
```

Container `CMD`:

```dockerfile
CMD ["armnet-runtime", "/app/main.py"]
```

Code that submits jobs from a dev machine or CI uses
[`armnet-client`](https://pypi.org/project/armnet-client/) instead.

## Install

```bash
pip install armnet-runtime
```

## Documentation

Full guides and API reference: **<https://safe-robotics.github.io/alpha-robotics/packages/runtime/>**
