Metadata-Version: 2.4
Name: antioch-py
Version: 2.0.3
Summary: The Antioch Python SDK
Author-email: Antioch Robotics <support@antioch.dev>
License-Expression: MIT
Project-URL: Homepage, https://antioch.com
Keywords: robotics,simulation,middleware,sdk
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: <3.13,>=3.12
Description-Content-Type: text/markdown
Requires-Dist: click>=8.0.0
Requires-Dist: click>=8.3.0
Requires-Dist: eclipse-zenoh>=1.5.0
Requires-Dist: google-cloud-artifact-registry>=1.16.1
Requires-Dist: httpx>=0.27.0
Requires-Dist: loguru>=0.7.3
Requires-Dist: msgpack==1.1.1
Requires-Dist: msgpack>=1.1.1
Requires-Dist: numpy==1.26.0
Requires-Dist: ormsgpack>=1.6.0
Requires-Dist: pydantic>=2.11.6
Requires-Dist: pydantic>=2.11.7
Requires-Dist: python-on-whales>=0.78.0
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: requests>=2.32.0
Requires-Dist: scipy==1.15.3
Requires-Dist: sortedcontainers-stubs>=2.4.3
Requires-Dist: sortedcontainers>=2.4.0
Requires-Dist: tqdm>=4.67.1

# antioch-py

Python SDK for the [Antioch](https://antioch.com) robotics simulation platform.

## Overview

The antioch-py package provides two main components:

### Module SDK (`antioch.module`)

Build robotics software modules in Python. The Module SDK is designed to be installed inside your module's Dockerfile, giving you access to the Antioch runtime for processing sensor data, controlling actuators, and communicating with other modules.

```python
from antioch.module import Module, Image, JointTargets

class MyController(Module):
    def execute(self, image: Image) -> JointTargets:
        # Your control logic here
        ...
```

### Session SDK (`antioch.session`)

Build and orchestrate simulation sessions programmatically. The Session SDK lets you create scenes, spawn robots, configure sensors, and run tasks from Python scripts or notebooks.

```python
from antioch.session import Session, Scene, Articulation

async with Session() as session:
    scene = await session.create_scene()
    robot = await scene.spawn(Articulation, usd_path="robot.usd")
    await scene.play()
```

## Installation

```bash
pip install antioch-py
```

### Docker (for modules)

```dockerfile
FROM python:3.12-slim

RUN pip install antioch-py

COPY . /app
WORKDIR /app

CMD ["python", "main.py"]
```

## Documentation

Visit [antioch.com](https://antioch.com) for full documentation and examples.

## License

MIT
