antioch-py 2.2.3__tar.gz → 3.0.0__tar.gz

antioch_py-3.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 Antioch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{antioch_py-2.2.3/antioch_py.egg-info → antioch_py-3.0.0}/PKG-INFO

@@ -1,23 +1,24 @@
 Metadata-Version: 2.4
 Name: antioch-py
-Version: 2.2.3
-Summary: The Antioch Python SDK
+Version: 3.0.0
+Summary: Antioch Python Module SDK
 Author-email: Antioch Robotics <support@antioch.dev>
 License-Expression: MIT
 Project-URL: Homepage, https://antioch.com
-Keywords: robotics,simulation,middleware,sdk
+Keywords: robotics,simulation,middleware,sdk,modules
 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
+Requires-Python: <3.13,>=3.10
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: click>=8.0.0
-Requires-Dist: click>=8.3.0
+Requires-Dist: docker>=7.0.0
 Requires-Dist: eclipse-zenoh>=1.5.0
-Requires-Dist: google-cloud-artifact-registry>=1.16.1
+Requires-Dist: foxglove-sdk>=0.14.1
 Requires-Dist: httpx>=0.27.0
 Requires-Dist: loguru>=0.7.3
 Requires-Dist: msgpack==1.1.1
@@ -26,13 +27,11 @@ 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
+Dynamic: license-file
 
 # antioch-py
 
@@ -78,9 +77,7 @@ ark = scene.add_ark(name="my_robot", version="0.1.0")
 task = Task()
 task.start(mcap_path="/tmp/recording.mcap")
 
-scene.play()
 scene.step(1_000_000)  # step 1 second
-scene.pause()
 
 task.finish(outcome=TaskOutcome.SUCCESS)
 ```

antioch_py-3.0.0/README.md

@@ -0,0 +1,105 @@
+# antioch-py
+
+The Antioch Python Module SDK for building deterministic robotic modules.
+
+## Overview
+
+`antioch-py` provides the Python client library for implementing Antioch modules - the core computational units that run inside Arks. Modules contain nodes that execute callbacks on a deterministic schedule, communicating via tokens.
+
+## Installation
+
+```bash
+pip install antioch-py
+```
+
+## Quick Start
+
+```python
+from antioch import Module, Execution
+
+def my_callback(execution: Execution) -> None:
+    """Process inputs and produce outputs."""
+    # Read input data
+    input_data = execution.input("sensor_data")
+    
+    # Process data
+    result = process(input_data)
+    
+    # Write output
+    execution.output("processed", result)
+
+# Create and run module
+module = Module()
+module.register("my_node", my_callback)
+module.spin()
+```
+
+## Key Concepts
+
+### Module
+
+The `Module` class is the main entry point for implementing Antioch modules. It handles:
+- Configuration loading from environment (container mode) or explicit parameters (local mode)
+- Node registration and lifecycle management
+- Startup handshake and synchronization
+
+### Node
+
+Nodes are the computational units within a module. Each node:
+- Runs in its own thread
+- Executes on a deterministic schedule
+- Receives input tokens and produces output tokens
+
+### Execution
+
+The `Execution` object is passed to node callbacks and provides:
+- Access to input data via `input(name)`
+- Output publishing via `output(name, data)`
+- Hardware read/write for simulation mode
+- Logging via `execution.logger`
+
+## Modes of Operation
+
+### Container Mode (Default)
+
+When running inside an Ark pod, the module automatically loads configuration from environment variables:
+- `_MODULE_NAME`: Module name
+- `_ARK`: Ark configuration JSON
+- `_ENVIRONMENT`: Execution environment (sim/real)
+- `_DEBUG`: Debug mode flag
+
+### Local Mode
+
+For testing and development, provide configuration explicitly:
+
+```python
+from antioch import Module, Environment
+
+module = Module(
+    module_name="my_module",
+    ark=my_ark_config,
+    environment=Environment.SIM,
+    debug=True,
+)
+```
+
+## API Reference
+
+### Module
+
+- `Module(module_name=None, ark=None, environment=Environment.REAL, debug=False)`: Create a module
+- `register(name, callback)`: Register a node callback
+- `spin()`: Start the module and wait for shutdown
+- `join(timeout=None)`: Wait for all nodes to finish
+
+### Execution
+
+- `input(name) -> list[Token]`: Get input tokens for an input
+- `output(name, data)`: Set output data for an output
+- `hardware_read(name) -> bytes`: Read hardware data (sim mode)
+- `hardware_write(name, data)`: Write hardware data (sim mode)
+- `logger`: Logger for telemetry and debugging
+
+## License
+
+MIT

{antioch_py-2.2.3 → antioch_py-3.0.0}/README.pypi.md

@@ -42,9 +42,7 @@ ark = scene.add_ark(name="my_robot", version="0.1.0")
 task = Task()
 task.start(mcap_path="/tmp/recording.mcap")
 
-scene.play()
 scene.step(1_000_000)  # step 1 second
-scene.pause()
 
 task.finish(outcome=TaskOutcome.SUCCESS)
 ```

antioch_py-2.2.3/antioch/message.py → antioch_py-3.0.0/antioch/__init__.py

@@ -1,3 +1,10 @@
+from antioch.clock import Clock
+from antioch.execution import Execution
+from antioch.input import NodeInputBuffer
+from antioch.module import Module
+from antioch.node import Node
+from common.ark import Environment
+from common.ark.token import Token, TokenType
 from common.message import (
     Array,
     Bool,
@@ -28,7 +35,6 @@ from common.message import (
     PointsAnnotationType,
     Pose,
     Quaternion,
-    RadarDetection,
     RadarScan,
     SerializationError,
     String,
@@ -38,6 +44,15 @@ from common.message import (
 )
 
 __all__ = [
+    # Core
+    "Clock",
+    "Environment",
+    "Execution",
+    "Module",
+    "Node",
+    "NodeInputBuffer",
+    "Token",
+    "TokenType",
     # Base types
     "Message",
     "MessageError",
@@ -69,7 +84,6 @@ __all__ = [
     "JointTarget",
     "JointTargets",
     # Sensor types
-    "RadarDetection",
     "RadarScan",
     "PointCloud",
     # Logging

{antioch_py-2.2.3/antioch/module → antioch_py-3.0.0/antioch}/execution.py

@@ -1,9 +1,9 @@
 import time
 from typing import TypeVar, overload
 
-from antioch.module.token import Token, TokenType
 from common.ark.module import ModuleParameter
 from common.ark.node import NodeOutput
+from common.ark.token import Token, TokenType
 from common.message import Image, ImuSample, JointStates, JointTargets, Message, PirStatus, RadarScan
 from common.utils.logger import Logger
 from common.utils.time import now_us

{antioch_py-2.2.3/antioch/module → antioch_py-3.0.0/antioch}/input.py

@@ -3,12 +3,10 @@ from threading import Lock
 import zenoh
 from sortedcontainers import SortedDict
 
-from antioch.module.token import Token, TokenType
 from common.ark.node import NodeInput
+from common.ark.token import ARK_TOKEN_PATH, Token, TokenType
 from common.utils.comms import CommsSession
 
-TOKEN_INPUT_PATH = "_token/{path}"
-
 
 class NodeInputBuffer:
     """
@@ -33,7 +31,7 @@ class NodeInputBuffer:
         self._tokens: SortedDict[tuple[int, str, str], Token] = SortedDict()
 
         # Subscribe to token path with callback
-        path = TOKEN_INPUT_PATH.format(path=config.path)
+        path = ARK_TOKEN_PATH.format(path=config.path)
         self._subscriber = comms.declare_callback_subscriber(path, self._on_token)
 
     def close(self) -> None:

{antioch_py-2.2.3/antioch/module → antioch_py-3.0.0/antioch}/module.py

@@ -4,35 +4,17 @@ import signal
 import threading
 from collections.abc import Callable
 
-from antioch.module.execution import Execution
-from antioch.module.node import Node
+from antioch.execution import Execution
+from antioch.node import Node
 from common.ark.ark import Ark, Environment
-from common.ark.module import ModuleParameter
-from common.message import Message
+from common.ark.module import ModuleParameter, ModuleReady, ModuleStart
 from common.utils.comms import CommsSession
 from common.utils.logger import Logger
 from common.utils.time import now_us
 
-AGENT_MODULE_READY_PATH = "_agent/module_ready"
-AGENT_MODULE_START_PATH = "_agent/module_start"
-
-
-class ModuleReady(Message):
-    """
-    Module ready message sent during handshake.
-    """
-
-    _type = "antioch/agent/module_ready"
-    module_name: str
-
-
-class ModuleStart(Message):
-    """
-    Module start message received during handshake.
-    """
-
-    _type = "antioch/agent/module_start"
-    global_start_time_us: int
+# Synchronization paths for module coordination
+ARK_MODULE_READY_PATH = "_ark/module_ready"
+ARK_MODULE_START_PATH = "_ark/module_start"
 
 
 class Module:
@@ -41,8 +23,8 @@ class Module:
     mode of operation:
 
     > Container Mode (default): The module runs inside a Kubernetes pod managed by the
-    Antioch agent. Configuration is automatically loaded from environment variables
-    set by the agent (_MODULE_NAME, _ARK, _ENVIRONMENT, _DEBUG).
+    Antioch runtime. Configuration is automatically loaded from environment variables
+    (_MODULE_NAME, _ARK, _ENVIRONMENT, _DEBUG).
 
     > Local Mode: The module runs standalone for testing and development. Configuration
     must be explicitly provided via constructor parameters (module_name, ark, environment,
@@ -53,8 +35,8 @@ class Module:
     before registering node callbacks.
 
     Users register node callbacks via register() and then call spin() to start execution.
-    The Ark will not start until spin() is called, which begins the handshake with the
-    agent and starts processing node callbacks.
+    The Ark will not start until spin() is called, which begins the synchronization
+    handshake and starts processing node callbacks.
 
     Example:
         # Container mode
@@ -142,8 +124,8 @@ class Module:
         """
 
         comms = CommsSession()
-        logger = Logger(comms, self.module_name, debug=self.debug, print_logs=True)
-        global_start_time_us = now_us() if self._is_local_mode else self._perform_agent_handshake(comms)
+        logger = Logger(base_channel=self.module_name, debug=self.debug, print_logs=True)
+        global_start_time_us = now_us() if self._is_local_mode else self._perform_startup_handshake(comms)
 
         # Validate node callbacks
         for node_name in self._node_callbacks:
@@ -174,6 +156,7 @@ class Module:
         self._shutdown_event.wait()
 
         logger.info("Module exiting")
+        logger.close()
         comms.close()
 
     def join(self, timeout: float | None = None) -> None:
@@ -190,9 +173,9 @@ class Module:
         for node in self._nodes.values():
             node.join(timeout=timeout)
 
-    def _perform_agent_handshake(self, comms: CommsSession) -> int:
+    def _perform_startup_handshake(self, comms: CommsSession) -> int:
         """
-        Perform handshake with agent to receive global start time.
+        Perform startup handshake to receive global start time.
 
         Publishes ready message and blocks waiting for start message containing
         the global start time for synchronization.
@@ -201,8 +184,8 @@ class Module:
         :return: Global start time in microseconds.
         """
 
-        ready_publisher = comms.declare_publisher(AGENT_MODULE_READY_PATH)
-        start_subscriber = comms.declare_subscriber(AGENT_MODULE_START_PATH)
+        ready_publisher = comms.declare_publisher(ARK_MODULE_READY_PATH)
+        start_subscriber = comms.declare_subscriber(ARK_MODULE_START_PATH)
         ready_publisher.publish(ModuleReady(module_name=self.module_name))
         start_msg = start_subscriber.recv(ModuleStart)
         return start_msg.global_start_time_us

{antioch_py-2.2.3/antioch/module → antioch_py-3.0.0/antioch}/node.py

@@ -2,22 +2,21 @@ import traceback
 from collections.abc import Callable
 from threading import Event, Thread
 
-from antioch.module.clock import Clock
-from antioch.module.execution import Execution
-from antioch.module.input import NodeInputBuffer
-from antioch.module.token import Token, TokenType
+from antioch.clock import Clock
+from antioch.execution import Execution
+from antioch.input import NodeInputBuffer
 from common.ark.ark import Environment
 from common.ark.module import Module
-from common.ark.node import Node as NodeConfig
-from common.ark.scheduler import InputToken, NodeEdge, NodeStartEvent, OnlineScheduler
-from common.ark.sim import SimNodeComplete, SimNodeStart
+from common.ark.node import Node as NodeConfig, NodeEdge, SimNodeComplete, SimNodeStart
+from common.ark.scheduler import NodeStartEvent, OnlineScheduler
+from common.ark.token import ARK_TOKEN_PATH, InputToken, Token, TokenType
 from common.utils.comms import CommsPublisher, CommsSession
 from common.utils.logger import Logger
 from common.utils.time import now_us
 
-TOKEN_OUTPUT_PATH = "_token/{path}"
-NODE_START_SUBSCRIBER_PATH = "_ark/node_start/{module}/{node}"
-NODE_COMPLETE_PUBLISHER_PATH = "_ark/node_complete/{module}/{node}"
+# Synchronization paths for node coordination
+ARK_NODE_START_PATH = "_ark/node_start/{module}/{node}"
+ARK_NODE_COMPLETE_PATH = "_ark/node_complete/{module}/{node}"
 
 
 class Node:
@@ -67,8 +66,8 @@ class Node:
         self._callback = callback
 
         self._comms = CommsSession()
-        self._logger = Logger(self._comms, module_name, debug=debug, print_logs=True)
-        self._execution_logger = Logger(self._comms, module_name, debug=debug, print_logs=True)
+        self._logger = Logger(base_channel=module_name, debug=debug, print_logs=True)
+        self._execution_logger = Logger(base_channel=module_name, debug=debug, print_logs=True)
         self._shutdown_requested = Event()
 
         # Create input buffers for all inputs
@@ -79,7 +78,7 @@ class Node:
         # Create output publishers for all outputs
         self._output_publishers: dict[str, CommsPublisher] = {}
         for output_name, output_config in node_config.outputs.items():
-            path = TOKEN_OUTPUT_PATH.format(path=output_config.path)
+            path = ARK_TOKEN_PATH.format(path=output_config.path)
             self._output_publishers[output_name] = self._comms.declare_publisher(path)
 
         # Create reusable execution context
@@ -115,7 +114,9 @@ class Node:
         for publisher in self._output_publishers.values():
             publisher.close()
 
-        # Close comms session
+        # Close loggers and comms session
+        self._logger.close()
+        self._execution_logger.close()
         self._comms.close()
 
     def join(self, timeout: float | None = None) -> None:
@@ -135,8 +136,8 @@ class Node:
         for shutdown events.
         """
 
-        start_path = NODE_START_SUBSCRIBER_PATH.format(module=self._module_name, node=self._node_name)
-        complete_path = NODE_COMPLETE_PUBLISHER_PATH.format(module=self._module_name, node=self._node_name)
+        start_path = ARK_NODE_START_PATH.format(module=self._module_name, node=self._node_name)
+        complete_path = ARK_NODE_COMPLETE_PATH.format(module=self._module_name, node=self._node_name)
         start_subscriber = self._comms.declare_async_subscriber(start_path)
         complete_publisher = self._comms.declare_publisher(complete_path)
 

{antioch_py-2.2.3 → antioch_py-3.0.0/antioch_py.egg-info}/PKG-INFO

@@ -1,23 +1,24 @@
 Metadata-Version: 2.4
 Name: antioch-py
-Version: 2.2.3
-Summary: The Antioch Python SDK
+Version: 3.0.0
+Summary: Antioch Python Module SDK
 Author-email: Antioch Robotics <support@antioch.dev>
 License-Expression: MIT
 Project-URL: Homepage, https://antioch.com
-Keywords: robotics,simulation,middleware,sdk
+Keywords: robotics,simulation,middleware,sdk,modules
 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
+Requires-Python: <3.13,>=3.10
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: click>=8.0.0
-Requires-Dist: click>=8.3.0
+Requires-Dist: docker>=7.0.0
 Requires-Dist: eclipse-zenoh>=1.5.0
-Requires-Dist: google-cloud-artifact-registry>=1.16.1
+Requires-Dist: foxglove-sdk>=0.14.1
 Requires-Dist: httpx>=0.27.0
 Requires-Dist: loguru>=0.7.3
 Requires-Dist: msgpack==1.1.1
@@ -26,13 +27,11 @@ 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
+Dynamic: license-file
 
 # antioch-py
 
@@ -78,9 +77,7 @@ ark = scene.add_ark(name="my_robot", version="0.1.0")
 task = Task()
 task.start(mcap_path="/tmp/recording.mcap")
 
-scene.play()
 scene.step(1_000_000)  # step 1 second
-scene.pause()
 
 task.finish(outcome=TaskOutcome.SUCCESS)
 ```

antioch_py-3.0.0/antioch_py.egg-info/SOURCES.txt

@@ -0,0 +1,66 @@
+LICENSE
+MANIFEST.in
+README.md
+README.pypi.md
+pyproject.toml
+antioch/__init__.py
+antioch/clock.py
+antioch/execution.py
+antioch/input.py
+antioch/module.py
+antioch/node.py
+antioch_py.egg-info/PKG-INFO
+antioch_py.egg-info/SOURCES.txt
+antioch_py.egg-info/dependency_links.txt
+antioch_py.egg-info/requires.txt
+antioch_py.egg-info/top_level.txt
+common/__init__.py
+common/constants.py
+common/ark/__init__.py
+common/ark/ark.py
+common/ark/hardware.py
+common/ark/kinematics.py
+common/ark/module.py
+common/ark/node.py
+common/ark/scheduler.py
+common/ark/sim.py
+common/ark/token.py
+common/assets/__init__.py
+common/assets/rigging.usd
+common/core/__init__.py
+common/core/auth.py
+common/core/container.py
+common/core/registry.py
+common/core/rome.py
+common/core/telemetry.py
+common/core/types.py
+common/message/__init__.py
+common/message/annotation.py
+common/message/array.py
+common/message/camera.py
+common/message/color.py
+common/message/detection.py
+common/message/foxglove.py
+common/message/frame.py
+common/message/image.py
+common/message/imu.py
+common/message/joint.py
+common/message/log.py
+common/message/message.py
+common/message/pir.py
+common/message/plot.py
+common/message/point.py
+common/message/point_cloud.py
+common/message/pose.py
+common/message/quaternion.py
+common/message/radar.py
+common/message/twist.py
+common/message/types.py
+common/message/vector.py
+common/sim/__init__.py
+common/sim/objects.py
+common/sim/state.py
+common/utils/__init__.py
+common/utils/comms.py
+common/utils/logger.py
+common/utils/time.py

{antioch_py-2.2.3 → antioch_py-3.0.0}/antioch_py.egg-info/requires.txt

@@ -1,7 +1,7 @@
 click>=8.0.0
-click>=8.3.0
+docker>=7.0.0
 eclipse-zenoh>=1.5.0
-google-cloud-artifact-registry>=1.16.1
+foxglove-sdk>=0.14.1
 httpx>=0.27.0
 loguru>=0.7.3
 msgpack==1.1.1
@@ -10,10 +10,7 @@ numpy==1.26.0
 ormsgpack>=1.6.0
 pydantic>=2.11.6
 pydantic>=2.11.7
-python-on-whales>=0.78.0
 pyyaml>=6.0.2
-requests>=2.32.0
 scipy==1.15.3
 sortedcontainers-stubs>=2.4.3
 sortedcontainers>=2.4.0
-tqdm>=4.67.1

{antioch_py-2.2.3 → antioch_py-3.0.0}/common/ark/__init__.py

@@ -1,29 +1,16 @@
-from common.ark.ark import (
-    Ark,
-    ArkInfo,
-    ArkMetadata,
-    ArkReference,
-    ArkVersionReference,
-    AssetReference,
-    AssetVersionReference,
-    Environment,
-    Kinematics,
-)
+from common.ark.ark import Ark, ArkInfo, ArkMetadata, Environment, Kinematics
 from common.ark.hardware import CameraHardware, Hardware, HardwareType, ImuHardware, PirHardware, RadarHardware
 from common.ark.kinematics import Joint, Link
 from common.ark.module import Module, ModuleImage, ModuleInfo, ModuleKind, ModuleParameter, ParamType
 from common.ark.node import HardwareAccessMode, Node, NodeInput, NodeOutput, NodeTimer
-from common.ark.scheduler import InputToken, NodeCompleteEvent, NodeEdge, NodeStartEvent, NodeState, OnlineScheduler, ScheduleEvent
+from common.ark.scheduler import NodeCompleteEvent, NodeEdge, NodeStartEvent, NodeState, OnlineScheduler, ScheduleEvent
+from common.ark.token import InputToken, Token, TokenType
 
 __all__ = [
     # Core Ark types
     "Ark",
     "ArkInfo",
     "ArkMetadata",
-    "AssetReference",
-    "AssetVersionReference",
-    "ArkReference",
-    "ArkVersionReference",
     "Environment",
     "Kinematics",
     # Module types
@@ -57,4 +44,7 @@ __all__ = [
     "ScheduleEvent",
     "NodeState",
     "OnlineScheduler",
+    # Token types
+    "Token",
+    "TokenType",
 ]