armnet-runtime 0.2.0__tar.gz → 0.3.0__tar.gz

armnet_runtime-0.3.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Ville Kuosmanen
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

{armnet_runtime-0.2.0 → armnet_runtime-0.3.0}/PKG-INFO

@@ -1,13 +1,14 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: armnet-runtime
-Version: 0.2.0
+Version: 0.3.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/
+Project-URL: Documentation, https://docs.armnet.dev/packages/runtime/
 Author: Ville Kuosmanen
-License: Apache-2.0
+License-Expression: Apache-2.0
+License-File: LICENSE
 Requires-Python: <3.13,>=3.12
-Requires-Dist: armnet-core>=0.2.0
+Requires-Dist: armnet-core>=0.3.0
 Requires-Dist: protobuf<7,>=5
 Requires-Dist: pydantic<3,>=2.6
 Provides-Extra: dev
@@ -50,4 +51,4 @@ pip install armnet-runtime
 
 ## Documentation
 
-Full guides and API reference: **<https://safe-robotics.github.io/alpha-robotics/packages/runtime/>**
+Full guides and API reference: **<https://docs.armnet.dev/packages/runtime/>**

{armnet_runtime-0.2.0 → armnet_runtime-0.3.0}/README.md

@@ -34,4 +34,4 @@ pip install armnet-runtime
 
 ## Documentation
 
-Full guides and API reference: **<https://safe-robotics.github.io/alpha-robotics/packages/runtime/>**
+Full guides and API reference: **<https://docs.armnet.dev/packages/runtime/>**

{armnet_runtime-0.2.0 → armnet_runtime-0.3.0}/pyproject.toml

@@ -6,15 +6,16 @@ build-backend = "hatchling.build"
 name = "armnet-runtime"
 # 0.2.0 follows armnet-core: ctx.cell now carries an environment and hands
 # reset/scoring to it, and CompletionStatus moved to armnet-core.
-version = "0.2.0"
+version = "0.3.0"
 description = "armnet runtime SDK \u2014 used by code running inside customer containers on a cell."
 readme = "README.md"
 requires-python = ">=3.12,<3.13"
-license = { text = "Apache-2.0" }
+license = "Apache-2.0"
+license-files = ["LICENSE"]
 authors = [{ name = "Ville Kuosmanen" }]
 
 dependencies = [
-    "armnet-core>=0.2.0",
+    "armnet-core>=0.3.0",
     "pydantic>=2.6,<3",
     # Wire format for Rerun visualization packets (armnet_runtime.rerun).
     "protobuf>=5,<7",
@@ -22,7 +23,7 @@ dependencies = [
 
 [project.urls]
 Homepage = "https://armnet.dev"
-Documentation = "https://safe-robotics.github.io/alpha-robotics/packages/runtime/"
+Documentation = "https://docs.armnet.dev/packages/runtime/"
 
 [project.optional-dependencies]
 dev = [

{armnet_runtime-0.2.0 → armnet_runtime-0.3.0}/src/armnet_runtime/cli.py

@@ -39,7 +39,7 @@ from typing import Sequence
 
 from armnet_runtime.context import build_context
 from armnet_runtime.decorator import registered_main
-from armnet_runtime.markers import (
+from armnet_core.markers import (
     MAX_TRACEBACK_BYTES,
     RESULT_MARKER,
     RESULT_MARKER_JSON,

{armnet_runtime-0.2.0 → armnet_runtime-0.3.0}/src/armnet_runtime/context.py

@@ -31,7 +31,7 @@ from armnet_core import (
     environment_for,
 )
 
-from armnet_runtime import env as env_keys
+from armnet_core import env as env_keys
 
 logger = logging.getLogger(__name__)
 
@@ -810,7 +810,7 @@ class Cell:
 
         # Imported locally to avoid pulling markers into the public API
         # surface of `Context`.
-        from armnet_runtime.markers import PROGRESS_MARKER
+        from armnet_core.markers import PROGRESS_MARKER
         print(f"{PROGRESS_MARKER} {message}", flush=True)
         time.sleep(0.01)
 
@@ -984,7 +984,7 @@ class Context:
 
         # Imported locally to avoid pulling markers into the public API
         # surface of `Context`.
-        from armnet_runtime.markers import PROGRESS_MARKER
+        from armnet_core.markers import PROGRESS_MARKER
         print(f"{PROGRESS_MARKER} {message}", flush=True)
 
     def is_shutting_down(self) -> bool:
@@ -1281,8 +1281,8 @@ def build_context() -> Context:
         camera_configs=_build_camera_configs(
             cell_config.camera_configs if cell_config else {}
         ),
-        cache_home=_path_from_env_or_config(env_keys.CACHE_HOME, None),
-        volume=Volume(root=_path_from_env_or_config(env_keys.VOLUME_HOME, None)),
+        cache_home=_mount_path(env_keys.CACHE_HOME, env_keys.LEGACY_CACHE_HOME),
+        volume=Volume(root=_mount_path(env_keys.VOLUME_HOME, env_keys.LEGACY_VOLUME_HOME)),
         secrets=_load_secrets(),
         timeout_seconds=timeout,
     )
@@ -1369,6 +1369,11 @@ def _path_from_env_or_config(env_key: str, configured: str | None) -> Path | Non
     return Path(value) if value else None
 
 
+def _mount_path(env_key: str, legacy_env_key: str) -> Path | None:
+    value = os.environ.get(env_key) or os.environ.get(legacy_env_key)
+    return Path(value) if value else None
+
+
 def _build_camera_configs(camera_configs: dict[str, Any] | None) -> dict[str, Any]:
     if not camera_configs:
         return {}

armnet_runtime-0.3.0/src/armnet_runtime/env.py

@@ -0,0 +1,9 @@
+"""Deprecated alias for :mod:`armnet_core.env`.
+
+These keys are a contract between the cell that sets them and everything that
+reads them, so they live in ``armnet-core`` where every side can reach them
+without depending on the runtime. Re-exported here so existing
+``from armnet_runtime import env`` imports keep working.
+"""
+
+from armnet_core.env import *  # noqa: F401,F403

{armnet_runtime-0.2.0 → armnet_runtime-0.3.0}/src/armnet_runtime/lerobot/import_swap.py

@@ -6,7 +6,7 @@ import importlib
 import logging
 import os
 
-from armnet_runtime import env as env_keys
+from armnet_core import env as env_keys
 from armnet_runtime.lerobot.remote_camera import RemoteOpenCVCamera
 from armnet_runtime.lerobot.remote_arx5 import RemoteARX5Arm
 from armnet_runtime.lerobot.remote_feetech import RemoteFeetechMotorsBus

{armnet_runtime-0.2.0 → armnet_runtime-0.3.0}/src/armnet_runtime/lerobot/remote_arx5.py

@@ -15,7 +15,7 @@ import os
 import time
 from typing import Any
 
-from armnet_runtime import env as env_keys
+from armnet_core import env as env_keys
 from armnet_runtime.lerobot._remote_protocol import (
     IS_CONNECTED_TTL_S,
     PersistentConnection,

{armnet_runtime-0.2.0 → armnet_runtime-0.3.0}/src/armnet_runtime/lerobot/remote_camera.py

@@ -15,7 +15,7 @@ import os
 import time
 from typing import Any
 
-from armnet_runtime import env as env_keys
+from armnet_core import env as env_keys
 from armnet_runtime.lerobot._remote_protocol import (
     CALL_STATS,
     IS_CONNECTED_TTL_S,

{armnet_runtime-0.2.0 → armnet_runtime-0.3.0}/src/armnet_runtime/lerobot/remote_feetech.py

@@ -20,7 +20,7 @@ import time
 from pathlib import Path
 from typing import Any
 
-from armnet_runtime import env as env_keys
+from armnet_core import env as env_keys
 from armnet_runtime.lerobot._remote_protocol import (
     IS_CONNECTED_TTL_S,
     PersistentConnection,

armnet_runtime-0.3.0/src/armnet_runtime/markers.py

@@ -0,0 +1,9 @@
+"""Deprecated alias for :mod:`armnet_core.markers`.
+
+The marker prefixes are a wire format between whatever writes them and
+whatever scans stdout for them, so they live in ``armnet-core``. Re-exported
+here so existing ``from armnet_runtime.markers import ...`` imports keep
+working.
+"""
+
+from armnet_core.markers import *  # noqa: F401,F403

{armnet_runtime-0.2.0 → armnet_runtime-0.3.0}/src/armnet_runtime/rerun.py

@@ -30,7 +30,7 @@ from collections import deque
 from typing import Any, Mapping, Optional
 
 from armnet_runtime import _rerun_pb2 as pb
-from armnet_runtime.markers import RERUN_MARKER_B64
+from armnet_core.markers import RERUN_MARKER_B64
 
 OBS_PREFIX = "observation"
 ACTION_PREFIX = "action"

armnet_runtime-0.3.0/src/armnet_runtime/volume_sync.py

@@ -0,0 +1,9 @@
+"""Deprecated alias for :mod:`armnet_core.volume_sync`.
+
+The mirroring engine is shared by the client CLI, the runtime, and the cell, so
+it lives in ``armnet-core``. Re-exported here so existing
+``from armnet_runtime import volume_sync`` imports keep working.
+"""
+
+from armnet_core.volume_sync import *  # noqa: F401,F403
+from armnet_core.volume_sync import ProgressReporter  # noqa: F401

armnet_runtime-0.2.0/src/armnet_runtime/env.py

@@ -1,54 +0,0 @@
-"""Env var keys the cell injects into customer containers.
-
-Single source of truth shared by the cell (which sets them) and the runtime
-SDK (which reads them).
-"""
-
-JOB_ID = "ARMNET_JOB_ID"
-EMBODIMENT = "ARMNET_EMBODIMENT"
-TASK = "ARMNET_TASK"
-# The kind of workcell the cell is set up as ("busybox"). Assigned in the FMS,
-# so it overrides whatever the cell's own config file happens to say.
-ENVIRONMENT = "ARMNET_ENVIRONMENT"
-TIMEOUT_SECONDS = "ARMNET_TIMEOUT_SECONDS"
-
-# JSON-encoded `dict[str, Any]`; decoded into `Context.args`. Optional \u2014
-# defaults to `{}` when absent (e.g. when developers run the runtime
-# outside the cell with no orchestrator-provided args).
-ARGS = "ARMNET_ARGS"
-
-# JSON-encoded `RobotCellConfig` for the physical cell hosting the container.
-# This is the preferred M2+ path for robot metadata; individual env vars below
-# remain as dev/backcompat overrides while the config shape settles.
-CELL_CONFIG = "ARMNET_CELL_CONFIG"
-
-# Robot connector endpoint mounted into customer containers. When set,
-# ctx.cell.robot_port points here and the runtime's LeRobot import replacement
-# routes Feetech bus access through it.
-CELL_SOCKET = "ARMNET_CELL_SOCKET"
-
-# Operator-call endpoint served by the `armnet-cell` process (localhost).
-# Operator-facing, human-in-the-loop calls (manual reset confirmation) are
-# routed here so the prompt lands on the cell's stdin (the operator's terminal),
-# not on a headless robot connector.
-OPERATOR_CALL_ENDPOINT = "ARMNET_OPERATOR_CALL_ENDPOINT"
-
-# Local-container-only control endpoint. Used by developer runs to provide
-# keyboard-driven completion/stop/reset behavior without cloud cell services.
-LOCAL_CONTROL_ENDPOINT = "ARMNET_LOCAL_CONTROL_ENDPOINT"
-LOCAL_CONTAINER = "ARMNET_LOCAL_CONTAINER"
-
-# Robot metadata provided by the cell. `ROBOT_ID` is used by LeRobot to look
-# up calibration; `CALIBRATION_DIR` points at the calibration store mounted
-# into the container when needed.
-ROBOT_ID = "ARMNET_ROBOT_ID"
-CALIBRATION_DIR = "ARMNET_CALIBRATION_DIR"
-CALIBRATION_FILE_PATH = "ARMNET_CALIBRATION_FILE_PATH"
-
-# Per-user persistent cache volume mounted by the robot cell.
-CACHE_HOME = "REMOTEROBOT_CACHE_HOME"
-VOLUME_HOME = "REMOTEROBOT_VOLUME_HOME"
-HF_HOME = "HF_HOME"
-
-# JSON-encoded mapping of injected secret env var names to values.
-SECRETS = "ARMNET_SECRETS"

armnet_runtime-0.2.0/src/armnet_runtime/markers.py

@@ -1,51 +0,0 @@
-"""Stdout marker constants.
-
-The runtime CLI prints distinctively-prefixed lines to stdout so the cell
-can extract structured information from otherwise-arbitrary container
-output. These prefixes are part of the wire format between the runtime CLI
-and the cell program; both must use the same constants.
-
-Why stdout and not stderr: the cell only scans stdout for markers, which
-keeps stderr semantically clean for human-facing log noise. The runtime
-CLI writes the human-readable traceback to stderr separately (via
-``traceback.print_exc()``) so unaided ``docker logs`` is still useful.
-"""
-
-# Human-readable result line prefix (e.g. "[armnet:result] {'ok': True}").
-RESULT_MARKER = "[armnet:result]"
-
-# Parseable result line prefix \u2014 the cell scans for this and JSON-decodes
-# everything after it into `JobResult.return_value`. Note the trailing
-# space: the JSON payload starts immediately after.
-RESULT_MARKER_JSON = f"{RESULT_MARKER}:json "
-
-# Parseable traceback line prefix \u2014 emitted by the runtime CLI when the
-# user's @main raises. JSON-decoded payload is the traceback string. The
-# cell lifts this onto `JobResult.traceback`.
-TRACEBACK_MARKER_JSON = "[armnet:traceback]:json "
-
-# Soft cap on the traceback string emitted via the marker, to keep NATS
-# message sizes sane. The cell's NATS server has `max_payload: 4 MiB`; a
-# 64 KiB cap leaves comfortable headroom for stdout/stderr alongside.
-# The full untruncated traceback is still in the container's stderr (which
-# the cell captures into `JobResult.stderr`), so power users have it.
-#
-# TODO(armnet): if real workloads start hitting this we should swap to
-# transparent gzip+base64 inside the marker (the model field stays a
-# string), or upload as an artifact and reference it.
-MAX_TRACEBACK_BYTES = 64 * 1024
-
-# Progress line prefix emitted by ``Context.report_progress(...)``.
-# Currently only used for visual grep in stdout; M1+ may add a structured
-# channel.
-PROGRESS_MARKER = "[armnet:progress]"
-
-# Rerun packet line prefix emitted by ``Context.log_rerun_data(...)``. The
-# payload after the prefix is base64-encoded ``armnet.rerun.RerunPacket``
-# bytes. The cell lifts these lines off stdout, base64-decodes them, and
-# republishes the raw protobuf bytes on ``logs.<job_id>.rerun`` (they are NOT
-# surfaced as normal log lines). stdout is the transport because the customer
-# container has no NATS access; base64 keeps the binary payload on a single
-# newline-delimited line.
-RERUN_MARKER = "[armnet:rerun]"
-RERUN_MARKER_B64 = f"{RERUN_MARKER}:b64 "