Metadata-Version: 2.4
Name: simulo-interfaces
Version: 0.20.2
Summary: Typed Python contracts for the Simulo cloud robotics SDK and managed simulation runtime.
Author-email: Simulo Team <team@simulo.ai>
License: BSD-3-Clause
Project-URL: Homepage, https://simulo.ai
Project-URL: Documentation, https://docs.simulo.ai
Project-URL: Quickstart, https://docs.simulo.ai/getting-started/quickstart/
Project-URL: Examples, https://github.com/simulo-org/simulo-samples
Project-URL: Simulo SDK, https://pypi.org/project/simulo/
Project-URL: Console, https://console.simulo.ai
Keywords: simulo,robotics,robotics SDK,robotics simulation,robot learning,cloud robotics,Python typing,type contracts,protocols
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Provides-Extra: dev
Requires-Dist: black==26.5.1; extra == "dev"
Requires-Dist: isort==8.0.1; extra == "dev"
Requires-Dist: ruff==0.15.21; extra == "dev"
Requires-Dist: mypy==2.3.0; extra == "dev"
Requires-Dist: pytest>=8.2; extra == "dev"
Requires-Dist: build>=1.2; extra == "dev"
Requires-Dist: twine>=5.1; extra == "dev"
Requires-Dist: packaging>=23; extra == "dev"
Provides-Extra: release
Requires-Dist: commitizen>=3.27; extra == "release"
Requires-Dist: build>=1.2; extra == "release"
Requires-Dist: twine>=5.1; extra == "release"

# Simulo Python Contracts for Cloud Robotics

`simulo-interfaces` provides stable, implementation-free Python type contracts
shared by the [Simulo SDK](https://pypi.org/project/simulo/) and its managed
cloud robotics simulation runtime. It defines protocols, enums, identifiers,
and dataclasses for robot-learning tasks, environments, policies, trainers,
applications, jobs, assets, checkpoints, and trained models.

## Install Simulo

For robotics simulation, reinforcement learning, and policy training with
Simulo, install the main SDK and CLI:

```bash
python -m pip install simulo
```

The `simulo` package installs `simulo-interfaces` automatically. Install this
distribution directly when building a type-checked integration that needs
Simulo contracts without the client implementation:

```bash
python -m pip install simulo-interfaces
```

## Package properties

- Python 3.11 or newer
- Standard library only, with zero runtime dependencies
- Torch-free and independent of simulation engines, CUDA, and cloud clients
- Typed with a `py.typed` marker for mypy and other static type checkers
- Runtime-checkable structural protocols that do not require inheritance
- Stable wire enums and records shared across the Simulo client and runtime

## Learn more

- [Simulo SDK on PyPI](https://pypi.org/project/simulo/)
- [Simulo documentation](https://docs.simulo.ai/)
- [Python API reference](https://docs.simulo.ai/api/)
- [Quickstart](https://docs.simulo.ai/getting-started/quickstart/)
- [Robotics samples](https://github.com/simulo-org/simulo-samples)
- [Simulo website](https://simulo.ai)
