simulo-interfaces 0.1.0__tar.gz → 0.1.1__tar.gz

simulo_interfaces-0.1.1/MANIFEST.in

@@ -0,0 +1,9 @@
+# Public-metadata discretion boundary (see release.yml Guard 5): the sdist is
+# PUBLIC on PyPI's "Download files" page just like the wheel, but setuptools'
+# sdist command auto-includes README.md and any top-level tests/ directory
+# regardless of the `readme = "PYPI.md"` pyproject setting. Exclude the
+# internal docs and test suite explicitly so only PYPI.md ships as prose.
+exclude README.md
+exclude CLAUDE.md
+exclude CHANGELOG.md
+prune tests

simulo_interfaces-0.1.1/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: simulo-interfaces
+Version: 0.1.1
+Summary: Type contracts for the Simulo SDK. Installed automatically as a dependency of the simulo package.
+Author-email: Simulo Team <team@simulo.ai>
+License: BSD-3-Clause
+Project-URL: Homepage, https://simulo.ai
+Keywords: simulo,robotics,contracts
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: black>=24.0; extra == "dev"
+Requires-Dist: isort>=5.13; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: pytest>=8.2; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5.1; 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-interfaces
+
+Type contracts (protocols, enums, and dataclasses) used by the [Simulo](https://pypi.org/project/simulo/)
+SDK.
+
+This package is installed automatically as a dependency of `simulo` and is not
+intended for direct installation.
+
+Learn more at [simulo.ai](https://simulo.ai).

simulo_interfaces-0.1.1/PYPI.md

@@ -0,0 +1,9 @@
+# simulo-interfaces
+
+Type contracts (protocols, enums, and dataclasses) used by the [Simulo](https://pypi.org/project/simulo/)
+SDK.
+
+This package is installed automatically as a dependency of `simulo` and is not
+intended for direct installation.
+
+Learn more at [simulo.ai](https://simulo.ai).

{simulo_interfaces-0.1.0 → simulo_interfaces-0.1.1}/pyproject.toml

@@ -4,13 +4,13 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "simulo-interfaces"
-version = "0.1.0"
-description = "Implementation-free contract layer for the Simulo platform — torch-free runtime/sim Protocols and platform/workspace domain contracts. Importable with no torch/numpy/gymnasium/Isaac installed."
-readme = "README.md"
+version = "0.1.1"
+description = "Type contracts for the Simulo SDK. Installed automatically as a dependency of the simulo package."
+readme = "PYPI.md"
 requires-python = ">=3.11"
 license = { text = "BSD-3-Clause" }
 authors = [{ name = "Simulo Team", email = "team@simulo.ai" }]
-keywords = ["robotics", "contracts", "protocols", "interfaces", "simulo"]
+keywords = ["simulo", "robotics", "contracts"]
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
@@ -20,26 +20,24 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Typing :: Typed",
 ]
-# ZERO runtime dependencies. Hard invariant (Rule #11): the thin client must
-# import this with no torch/numpy/gymnasium/Isaac/AWS/HTTP present. Enforced by
-# tests/test_no_heavy_deps.py + tests/test_import_without_torch.py.
+# ZERO runtime dependencies — must import cleanly with no
+# torch/numpy/gymnasium/Isaac/AWS/HTTP present. Enforced by
+# test_no_heavy_deps.py + test_import_without_torch.py.
 dependencies = []
 
 [project.optional-dependencies]
 dev = ["black>=24.0", "isort>=5.13", "ruff>=0.5", "mypy>=1.10", "pytest>=8.2", "build>=1.2", "twine>=5.1"]
-# Mirrors simulo-backend's [release] extra. `dev` above carries build/twine
-# but deliberately NOT commitizen — the release skill (.claude/skills/release/
-# SKILL.md) installs THIS extra specifically so `cz` is available without
-# also pulling in a second copy of build/twine.
+# `dev` carries build/twine but deliberately not commitizen; `release` below
+# adds commitizen for cutting version bumps without a second build/twine copy.
 release = ["commitizen>=3.27", "build>=1.2", "twine>=5.1"]
 
 [project.urls]
 Homepage = "https://simulo.ai"
-Source = "https://github.com/simulo-org/simulo-platform"
 
-# PEP 420 namespace package: NO src/simulo/__init__.py. `namespaces = true`
-# makes setuptools pick up simulo.interfaces.* while leaving `simulo` a shared
-# namespace simulo-backend also contributes to. Mirrors simulo-backend exactly.
+# Namespace packaging: no `src/simulo/__init__.py` here — this distribution
+# contributes only `simulo.interfaces.*` beneath the shared top-level `simulo`
+# name. `namespaces = true` keeps setuptools from choking on the shared
+# top-level name.
 [tool.setuptools.packages.find]
 where = ["src"]
 namespaces = true
@@ -72,15 +70,13 @@ line-length = 120
 target-version = ["py311"]
 
 # --- Commitizen ------------------------------------------------------------
-# Path B release flow (see `.claude/skills/release/SKILL.md`): `cz bump` here
-# creates the bump commit + tag locally; `.github/workflows/release.yml`
-# publishes to PyPI on tag push. version_provider = "pep621" reads/writes
-# [project].version directly; there is no in-tree __version__ mirror to keep
-# in sync (version_files = []).
+# `cz bump` creates the version-bump commit + tag locally; CI publishes to
+# PyPI on tag push. version_provider = "pep621" reads/writes [project].version
+# directly; there is no in-tree __version__ mirror to keep in sync
+# (version_files = []).
 #
-# The FIRST release is a hand-written bump commit per the release skill's
-# First-release appendix, NOT a `cz bump` — this package's version is
-# already 0.1.0 with no releasable commits since repo history began, so a
+# The FIRST release is a hand-written bump commit, not a `cz bump` — this
+# package's version is already 0.1.0 with no releasable commits yet, so a
 # real `cz bump --dry-run` would report "no increment"; the first tag simply
 # publishes the current 0.1.0 as-is.
 [tool.commitizen]

simulo_interfaces-0.1.1/src/simulo_interfaces.egg-info/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.4
+Name: simulo-interfaces
+Version: 0.1.1
+Summary: Type contracts for the Simulo SDK. Installed automatically as a dependency of the simulo package.
+Author-email: Simulo Team <team@simulo.ai>
+License: BSD-3-Clause
+Project-URL: Homepage, https://simulo.ai
+Keywords: simulo,robotics,contracts
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: black>=24.0; extra == "dev"
+Requires-Dist: isort>=5.13; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: pytest>=8.2; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5.1; 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-interfaces
+
+Type contracts (protocols, enums, and dataclasses) used by the [Simulo](https://pypi.org/project/simulo/)
+SDK.
+
+This package is installed automatically as a dependency of `simulo` and is not
+intended for direct installation.
+
+Learn more at [simulo.ai](https://simulo.ai).

{simulo_interfaces-0.1.0 → simulo_interfaces-0.1.1}/src/simulo_interfaces.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
-README.md
+MANIFEST.in
+PYPI.md
 pyproject.toml
 src/simulo/interfaces/__init__.py
 src/simulo/interfaces/exceptions.py
@@ -29,14 +30,4 @@ src/simulo_interfaces.egg-info/PKG-INFO
 src/simulo_interfaces.egg-info/SOURCES.txt
 src/simulo_interfaces.egg-info/dependency_links.txt
 src/simulo_interfaces.egg-info/requires.txt
-src/simulo_interfaces.egg-info/top_level.txt
-tests/test_anomaly_contract.py
-tests/test_domain_dataclasses.py
-tests/test_enums.py
-tests/test_ids.py
-tests/test_import_without_torch.py
-tests/test_no_heavy_deps.py
-tests/test_platform_protocols.py
-tests/test_runs_contract.py
-tests/test_runtime_protocols.py
-tests/test_submit_contract.py
+src/simulo_interfaces.egg-info/top_level.txt

simulo_interfaces-0.1.0/PKG-INFO

@@ -1,166 +0,0 @@
-Metadata-Version: 2.4
-Name: simulo-interfaces
-Version: 0.1.0
-Summary: Implementation-free contract layer for the Simulo platform — torch-free runtime/sim Protocols and platform/workspace domain contracts. Importable with no torch/numpy/gymnasium/Isaac installed.
-Author-email: Simulo Team <team@simulo.ai>
-License: BSD-3-Clause
-Project-URL: Homepage, https://simulo.ai
-Project-URL: Source, https://github.com/simulo-org/simulo-platform
-Keywords: robotics,contracts,protocols,interfaces,simulo
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Typing :: Typed
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-Provides-Extra: dev
-Requires-Dist: black>=24.0; extra == "dev"
-Requires-Dist: isort>=5.13; extra == "dev"
-Requires-Dist: ruff>=0.5; extra == "dev"
-Requires-Dist: mypy>=1.10; extra == "dev"
-Requires-Dist: pytest>=8.2; extra == "dev"
-Requires-Dist: build>=1.2; extra == "dev"
-Requires-Dist: twine>=5.1; 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-interfaces
-
-The **implementation-free contract layer** for the Simulo platform. A single,
-stable, torch-free, **zero-runtime-dependency** package that both Simulo SDK
-distributions depend on:
-
-- `simulo-backend` — the cloud GPU SDK (torch + IsaacLab + Isaac Sim).
-- `simulo` — the future thin local client (no heavy deps).
-
-Because both distributions share these contracts, `simulo-interfaces` is the one
-place the runtime Protocols and the platform/workspace domain model are defined.
-
-## What it is
-
-A pure-stdlib set of `typing.Protocol` contracts, frozen dataclasses, enums,
-`NewType` identifiers, and an exception hierarchy. Nothing here does any work —
-it only describes shapes.
-
-## What it is NOT
-
-It imports **none** of: `torch`, `numpy`, `gymnasium`, IsaacLab / Isaac Sim, AWS
-SDKs, HTTP clients, or database drivers. It performs **no** I/O, persistence, or
-computation. It is **not** a dumping ground (Contract Rule #12) — only contracts
-shared by more than one distribution belong here.
-
-The central invariant (Contract Rule #11): this package must import on a laptop
-with no torch/numpy/gymnasium/Isaac installed. Two tests enforce it:
-`tests/test_import_without_torch.py` (no heavy module enters `sys.modules`) and
-`tests/test_no_heavy_deps.py` (zero unconditional `Requires-Dist`).
-
-## Two parts
-
-### Part A — `simulo.interfaces.runtime`
-
-Tensor-library-agnostic structural mirrors of the `simulo.core` runtime surface.
-Tensors are typed as `TensorLike` (an alias for `Any`) so the contracts never
-bind to a concrete tensor library.
-
-- `TaskProtocol`, `PolicyProtocol`, `TrainerProtocol`, `PlayerProtocol`
-- `LearningEnvProtocol`, `ScenarioProtocol`
-- `ObservationComponentProtocol`, `RewardComponentProtocol`,
-  `TerminationConditionProtocol`
-- `PolicyExporterProtocol` — the narrow *optional* export capability
-  (`export_policy(path) -> str`). Deliberately not a `TrainerProtocol` member:
-  a Protocol binds all implementations, and only some trainers (today
-  `simulo.core.trainer.RLTrainer`) can deliver a deterministic standalone
-  policy export. Consumers feature-detect with `isinstance(trainer,
-  PolicyExporterProtocol)`.
-
-### Part B — `simulo.interfaces.platform`
-
-The platform/workspace domain contracts:
-
-- **Enums** — `JobStatus`, `ResumePolicy`, `ResourceKind`, `ArtifactKind`.
-- **Domain dataclasses** (frozen, slotted, keyword-only) — `Tag`, `Project`,
-  `Package`, `Resource`, `Job`, `Checkpoint`, `TrainedModel`.
-- **Cloud-execution Protocols** — `AppProtocol`, `JobFunctionProtocol`,
-  `RuntimeProtocol`, `AssetProtocol`, `VolumeProtocol`, `JobCallbackProtocol`,
-  `DebugSessionProtocol`, `ReplaySessionProtocol`, `VisualizationSessionProtocol`.
-
-## Public import surface
-
-```python
-import simulo.interfaces as si
-
-# exceptions + ids re-exported at the top level
-si.SimuloError, si.ContractViolationError, si.JobFailedError
-si.ProjectId, si.JobId, si.ResourceUri, si.Digest
-
-# Part A
-from simulo.interfaces.runtime import TaskProtocol, PolicyProtocol, LearningEnvProtocol
-
-# Part B
-from simulo.interfaces.platform import (
-    JobStatus, ResumePolicy, ResourceKind, ArtifactKind,
-    Project, Package, Job, Resource, Checkpoint, TrainedModel, Tag,
-    AppProtocol, RuntimeProtocol, AssetProtocol, VolumeProtocol,
-)
-```
-
-## Conformance model
-
-The contracts are `typing.Protocol`s — implementers conform **structurally**, no
-inheritance required.
-
-- **Static** — implementers (e.g. `simulo-backend`) are type-checked against
-  these Protocols by mypy. That static assertion is the primary conformance
-  gate and lives in the **implementer** package, not here.
-- **Runtime** — every Protocol is `@runtime_checkable`, so `isinstance(obj,
-  SomeProtocol)` provides a lightweight smoke check (presence of members only —
-  not signatures). This package's tests use that smoke form.
-- **Nominal (optional, opt-in per implementer)** — `simulo-backend`'s
-  `simulo.core` classes additionally *declare* the Part A Protocols as base
-  classes, so mypy drift-checks each implementation against its mirror at the
-  class-definition site. Nominal declaration never replaces the structural
-  contract — a third-party implementation that merely matches the signatures
-  still conforms.
-
-## Domain-model invariants
-
-- **Package ≠ Job** (Rule #5) — a `Package` is an immutable, content-addressed
-  source archive; a `Job` is one execution of a package and references it by id.
-- **Resource ≠ Package** (Rule #6) — a `Resource` is a read-only, versioned,
-  registry-resolved mount (robot / environment / dataset / …).
-- **Checkpoint ≠ TrainedModel** (Rule #8) — an intermediate training artifact is
-  a distinct type from the final, deployable model. Never collapse them.
-- **Project is the anchor** (Rule #7) — every other domain object hangs off a
-  `Project`.
-- **No packaged-skill type** (Rule #11) — there is deliberately no `Skill` /
-  `PackagedSkill` type here.
-
-## Stability policy
-
-- Enum **values** are a stable wire ABI: append-only, never renumber or rename.
-- Dataclass fields and Protocol method signatures follow the same
-  breaking-change discipline as the rest of the contract layer.
-- The package follows SemVer; additive changes (new optional field, new
-  Protocol, new enum member at the end) are minor/patch, removals/renames major.
-
-## Requirements
-
-- Python **>= 3.11** (uses `enum.StrEnum`). Tested on 3.11 and 3.12.
-- Standard library only — **zero** runtime dependencies.
-
-## Development
-
-```bash
-pip install -e ".[dev]"
-ruff check src
-black --check src tests
-isort --check-only src tests
-mypy src            # strict
-python -m build && twine check dist/*
-pytest
-```

simulo_interfaces-0.1.0/README.md

@@ -1,135 +0,0 @@
-# simulo-interfaces
-
-The **implementation-free contract layer** for the Simulo platform. A single,
-stable, torch-free, **zero-runtime-dependency** package that both Simulo SDK
-distributions depend on:
-
-- `simulo-backend` — the cloud GPU SDK (torch + IsaacLab + Isaac Sim).
-- `simulo` — the future thin local client (no heavy deps).
-
-Because both distributions share these contracts, `simulo-interfaces` is the one
-place the runtime Protocols and the platform/workspace domain model are defined.
-
-## What it is
-
-A pure-stdlib set of `typing.Protocol` contracts, frozen dataclasses, enums,
-`NewType` identifiers, and an exception hierarchy. Nothing here does any work —
-it only describes shapes.
-
-## What it is NOT
-
-It imports **none** of: `torch`, `numpy`, `gymnasium`, IsaacLab / Isaac Sim, AWS
-SDKs, HTTP clients, or database drivers. It performs **no** I/O, persistence, or
-computation. It is **not** a dumping ground (Contract Rule #12) — only contracts
-shared by more than one distribution belong here.
-
-The central invariant (Contract Rule #11): this package must import on a laptop
-with no torch/numpy/gymnasium/Isaac installed. Two tests enforce it:
-`tests/test_import_without_torch.py` (no heavy module enters `sys.modules`) and
-`tests/test_no_heavy_deps.py` (zero unconditional `Requires-Dist`).
-
-## Two parts
-
-### Part A — `simulo.interfaces.runtime`
-
-Tensor-library-agnostic structural mirrors of the `simulo.core` runtime surface.
-Tensors are typed as `TensorLike` (an alias for `Any`) so the contracts never
-bind to a concrete tensor library.
-
-- `TaskProtocol`, `PolicyProtocol`, `TrainerProtocol`, `PlayerProtocol`
-- `LearningEnvProtocol`, `ScenarioProtocol`
-- `ObservationComponentProtocol`, `RewardComponentProtocol`,
-  `TerminationConditionProtocol`
-- `PolicyExporterProtocol` — the narrow *optional* export capability
-  (`export_policy(path) -> str`). Deliberately not a `TrainerProtocol` member:
-  a Protocol binds all implementations, and only some trainers (today
-  `simulo.core.trainer.RLTrainer`) can deliver a deterministic standalone
-  policy export. Consumers feature-detect with `isinstance(trainer,
-  PolicyExporterProtocol)`.
-
-### Part B — `simulo.interfaces.platform`
-
-The platform/workspace domain contracts:
-
-- **Enums** — `JobStatus`, `ResumePolicy`, `ResourceKind`, `ArtifactKind`.
-- **Domain dataclasses** (frozen, slotted, keyword-only) — `Tag`, `Project`,
-  `Package`, `Resource`, `Job`, `Checkpoint`, `TrainedModel`.
-- **Cloud-execution Protocols** — `AppProtocol`, `JobFunctionProtocol`,
-  `RuntimeProtocol`, `AssetProtocol`, `VolumeProtocol`, `JobCallbackProtocol`,
-  `DebugSessionProtocol`, `ReplaySessionProtocol`, `VisualizationSessionProtocol`.
-
-## Public import surface
-
-```python
-import simulo.interfaces as si
-
-# exceptions + ids re-exported at the top level
-si.SimuloError, si.ContractViolationError, si.JobFailedError
-si.ProjectId, si.JobId, si.ResourceUri, si.Digest
-
-# Part A
-from simulo.interfaces.runtime import TaskProtocol, PolicyProtocol, LearningEnvProtocol
-
-# Part B
-from simulo.interfaces.platform import (
-    JobStatus, ResumePolicy, ResourceKind, ArtifactKind,
-    Project, Package, Job, Resource, Checkpoint, TrainedModel, Tag,
-    AppProtocol, RuntimeProtocol, AssetProtocol, VolumeProtocol,
-)
-```
-
-## Conformance model
-
-The contracts are `typing.Protocol`s — implementers conform **structurally**, no
-inheritance required.
-
-- **Static** — implementers (e.g. `simulo-backend`) are type-checked against
-  these Protocols by mypy. That static assertion is the primary conformance
-  gate and lives in the **implementer** package, not here.
-- **Runtime** — every Protocol is `@runtime_checkable`, so `isinstance(obj,
-  SomeProtocol)` provides a lightweight smoke check (presence of members only —
-  not signatures). This package's tests use that smoke form.
-- **Nominal (optional, opt-in per implementer)** — `simulo-backend`'s
-  `simulo.core` classes additionally *declare* the Part A Protocols as base
-  classes, so mypy drift-checks each implementation against its mirror at the
-  class-definition site. Nominal declaration never replaces the structural
-  contract — a third-party implementation that merely matches the signatures
-  still conforms.
-
-## Domain-model invariants
-
-- **Package ≠ Job** (Rule #5) — a `Package` is an immutable, content-addressed
-  source archive; a `Job` is one execution of a package and references it by id.
-- **Resource ≠ Package** (Rule #6) — a `Resource` is a read-only, versioned,
-  registry-resolved mount (robot / environment / dataset / …).
-- **Checkpoint ≠ TrainedModel** (Rule #8) — an intermediate training artifact is
-  a distinct type from the final, deployable model. Never collapse them.
-- **Project is the anchor** (Rule #7) — every other domain object hangs off a
-  `Project`.
-- **No packaged-skill type** (Rule #11) — there is deliberately no `Skill` /
-  `PackagedSkill` type here.
-
-## Stability policy
-
-- Enum **values** are a stable wire ABI: append-only, never renumber or rename.
-- Dataclass fields and Protocol method signatures follow the same
-  breaking-change discipline as the rest of the contract layer.
-- The package follows SemVer; additive changes (new optional field, new
-  Protocol, new enum member at the end) are minor/patch, removals/renames major.
-
-## Requirements
-
-- Python **>= 3.11** (uses `enum.StrEnum`). Tested on 3.11 and 3.12.
-- Standard library only — **zero** runtime dependencies.
-
-## Development
-
-```bash
-pip install -e ".[dev]"
-ruff check src
-black --check src tests
-isort --check-only src tests
-mypy src            # strict
-python -m build && twine check dist/*
-pytest
-```

simulo_interfaces-0.1.0/src/simulo_interfaces.egg-info/PKG-INFO

@@ -1,166 +0,0 @@
-Metadata-Version: 2.4
-Name: simulo-interfaces
-Version: 0.1.0
-Summary: Implementation-free contract layer for the Simulo platform — torch-free runtime/sim Protocols and platform/workspace domain contracts. Importable with no torch/numpy/gymnasium/Isaac installed.
-Author-email: Simulo Team <team@simulo.ai>
-License: BSD-3-Clause
-Project-URL: Homepage, https://simulo.ai
-Project-URL: Source, https://github.com/simulo-org/simulo-platform
-Keywords: robotics,contracts,protocols,interfaces,simulo
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Typing :: Typed
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-Provides-Extra: dev
-Requires-Dist: black>=24.0; extra == "dev"
-Requires-Dist: isort>=5.13; extra == "dev"
-Requires-Dist: ruff>=0.5; extra == "dev"
-Requires-Dist: mypy>=1.10; extra == "dev"
-Requires-Dist: pytest>=8.2; extra == "dev"
-Requires-Dist: build>=1.2; extra == "dev"
-Requires-Dist: twine>=5.1; 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-interfaces
-
-The **implementation-free contract layer** for the Simulo platform. A single,
-stable, torch-free, **zero-runtime-dependency** package that both Simulo SDK
-distributions depend on:
-
-- `simulo-backend` — the cloud GPU SDK (torch + IsaacLab + Isaac Sim).
-- `simulo` — the future thin local client (no heavy deps).
-
-Because both distributions share these contracts, `simulo-interfaces` is the one
-place the runtime Protocols and the platform/workspace domain model are defined.
-
-## What it is
-
-A pure-stdlib set of `typing.Protocol` contracts, frozen dataclasses, enums,
-`NewType` identifiers, and an exception hierarchy. Nothing here does any work —
-it only describes shapes.
-
-## What it is NOT
-
-It imports **none** of: `torch`, `numpy`, `gymnasium`, IsaacLab / Isaac Sim, AWS
-SDKs, HTTP clients, or database drivers. It performs **no** I/O, persistence, or
-computation. It is **not** a dumping ground (Contract Rule #12) — only contracts
-shared by more than one distribution belong here.
-
-The central invariant (Contract Rule #11): this package must import on a laptop
-with no torch/numpy/gymnasium/Isaac installed. Two tests enforce it:
-`tests/test_import_without_torch.py` (no heavy module enters `sys.modules`) and
-`tests/test_no_heavy_deps.py` (zero unconditional `Requires-Dist`).
-
-## Two parts
-
-### Part A — `simulo.interfaces.runtime`
-
-Tensor-library-agnostic structural mirrors of the `simulo.core` runtime surface.
-Tensors are typed as `TensorLike` (an alias for `Any`) so the contracts never
-bind to a concrete tensor library.
-
-- `TaskProtocol`, `PolicyProtocol`, `TrainerProtocol`, `PlayerProtocol`
-- `LearningEnvProtocol`, `ScenarioProtocol`
-- `ObservationComponentProtocol`, `RewardComponentProtocol`,
-  `TerminationConditionProtocol`
-- `PolicyExporterProtocol` — the narrow *optional* export capability
-  (`export_policy(path) -> str`). Deliberately not a `TrainerProtocol` member:
-  a Protocol binds all implementations, and only some trainers (today
-  `simulo.core.trainer.RLTrainer`) can deliver a deterministic standalone
-  policy export. Consumers feature-detect with `isinstance(trainer,
-  PolicyExporterProtocol)`.
-
-### Part B — `simulo.interfaces.platform`
-
-The platform/workspace domain contracts:
-
-- **Enums** — `JobStatus`, `ResumePolicy`, `ResourceKind`, `ArtifactKind`.
-- **Domain dataclasses** (frozen, slotted, keyword-only) — `Tag`, `Project`,
-  `Package`, `Resource`, `Job`, `Checkpoint`, `TrainedModel`.
-- **Cloud-execution Protocols** — `AppProtocol`, `JobFunctionProtocol`,
-  `RuntimeProtocol`, `AssetProtocol`, `VolumeProtocol`, `JobCallbackProtocol`,
-  `DebugSessionProtocol`, `ReplaySessionProtocol`, `VisualizationSessionProtocol`.
-
-## Public import surface
-
-```python
-import simulo.interfaces as si
-
-# exceptions + ids re-exported at the top level
-si.SimuloError, si.ContractViolationError, si.JobFailedError
-si.ProjectId, si.JobId, si.ResourceUri, si.Digest
-
-# Part A
-from simulo.interfaces.runtime import TaskProtocol, PolicyProtocol, LearningEnvProtocol
-
-# Part B
-from simulo.interfaces.platform import (
-    JobStatus, ResumePolicy, ResourceKind, ArtifactKind,
-    Project, Package, Job, Resource, Checkpoint, TrainedModel, Tag,
-    AppProtocol, RuntimeProtocol, AssetProtocol, VolumeProtocol,
-)
-```
-
-## Conformance model
-
-The contracts are `typing.Protocol`s — implementers conform **structurally**, no
-inheritance required.
-
-- **Static** — implementers (e.g. `simulo-backend`) are type-checked against
-  these Protocols by mypy. That static assertion is the primary conformance
-  gate and lives in the **implementer** package, not here.
-- **Runtime** — every Protocol is `@runtime_checkable`, so `isinstance(obj,
-  SomeProtocol)` provides a lightweight smoke check (presence of members only —
-  not signatures). This package's tests use that smoke form.
-- **Nominal (optional, opt-in per implementer)** — `simulo-backend`'s
-  `simulo.core` classes additionally *declare* the Part A Protocols as base
-  classes, so mypy drift-checks each implementation against its mirror at the
-  class-definition site. Nominal declaration never replaces the structural
-  contract — a third-party implementation that merely matches the signatures
-  still conforms.
-
-## Domain-model invariants
-
-- **Package ≠ Job** (Rule #5) — a `Package` is an immutable, content-addressed
-  source archive; a `Job` is one execution of a package and references it by id.
-- **Resource ≠ Package** (Rule #6) — a `Resource` is a read-only, versioned,
-  registry-resolved mount (robot / environment / dataset / …).
-- **Checkpoint ≠ TrainedModel** (Rule #8) — an intermediate training artifact is
-  a distinct type from the final, deployable model. Never collapse them.
-- **Project is the anchor** (Rule #7) — every other domain object hangs off a
-  `Project`.
-- **No packaged-skill type** (Rule #11) — there is deliberately no `Skill` /
-  `PackagedSkill` type here.
-
-## Stability policy
-
-- Enum **values** are a stable wire ABI: append-only, never renumber or rename.
-- Dataclass fields and Protocol method signatures follow the same
-  breaking-change discipline as the rest of the contract layer.
-- The package follows SemVer; additive changes (new optional field, new
-  Protocol, new enum member at the end) are minor/patch, removals/renames major.
-
-## Requirements
-
-- Python **>= 3.11** (uses `enum.StrEnum`). Tested on 3.11 and 3.12.
-- Standard library only — **zero** runtime dependencies.
-
-## Development
-
-```bash
-pip install -e ".[dev]"
-ruff check src
-black --check src tests
-isort --check-only src tests
-mypy src            # strict
-python -m build && twine check dist/*
-pytest
-```