digitalkin 0.4.2.dev1__tar.gz → 1.0.0.dev1__tar.gz

{digitalkin-0.4.2.dev1 → digitalkin-1.0.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalkin
-Version: 0.4.2.dev1
+Version: 1.0.0.dev1
 Summary: SDK to build kin used in DigitalKin
 Author-email: "DigitalKin.ai" <contact@digitalkin.ai>
 License: Attribution-NonCommercial-ShareAlike 4.0 International
@@ -452,23 +452,21 @@ Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: ag-ui-protocol>=0.1.14
-Requires-Dist: agentic-mesh-protocol==0.2.3
-Requires-Dist: anyio==4.13.0
-Requires-Dist: grpcio-health-checking==1.78.0
-Requires-Dist: grpcio-reflection==1.78.0
-Requires-Dist: grpcio-status==1.78.0
-Requires-Dist: pydantic==2.12.5
+Requires-Dist: ag-ui-protocol>=0.1.18
+Requires-Dist: agentic-mesh-protocol==1.0.0.dev1
+Requires-Dist: anyio>=4.13.0
+Requires-Dist: grpcio-health-checking==1.80.0
+Requires-Dist: grpcio-reflection==1.80.0
+Requires-Dist: grpcio-status==1.80.0
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: pydantic-settings>=2.14.0
+Requires-Dist: redis[hiredis]<8,>=7.4.0
+Provides-Extra: performance
+Requires-Dist: uvloop>=0.21; extra == "performance"
 Provides-Extra: profiling
-Requires-Dist: asyncio-inspector==0.1.0; extra == "profiling"
-Requires-Dist: pyinstrument==5.1.2; extra == "profiling"
-Requires-Dist: viztracer==1.1.1; extra == "profiling"
-Requires-Dist: yappi==1.7.6; extra == "profiling"
-Provides-Extra: taskiq
-Requires-Dist: rstream==1.0.0; extra == "taskiq"
-Requires-Dist: taskiq-aio-pika==0.6.0; extra == "taskiq"
-Requires-Dist: taskiq-redis==1.2.2; extra == "taskiq"
-Requires-Dist: taskiq[reload]==0.12.1; extra == "taskiq"
+Requires-Dist: pyinstrument>=5.1.2; extra == "profiling"
+Requires-Dist: viztracer>=1.1.1; extra == "profiling"
+Requires-Dist: yappi>=1.7.6; extra == "profiling"
 Dynamic: license-file
 
 # DigitalKin Python SDK
@@ -499,8 +497,7 @@ communicate over gRPC, register with a service mesh, and scale independently.
 - **Profiling** — optional `[profiling]` extra with asyncio-inspector,
   pyinstrument, viztracer, and yappi
 - **Batched history writes** — efficient storage writes for conversation history
-- **TaskIQ integration** — optional distributed task execution backed by
-  RabbitMQ and Redis (`[taskiq]` extra)
+- **Redis Streams** — durable message passing, crash recovery, and reconnection
 
 ## Installation
 
@@ -515,11 +512,11 @@ pip install digitalkin
 **Optional extras:**
 
 ```bash
-# Distributed task execution (RabbitMQ + Redis)
-uv add "digitalkin[taskiq]"
-
 # Async profiling tools
 uv add "digitalkin[profiling]"
+
+# uvloop for faster event loop
+uv add "digitalkin[performance]"
 ```
 
 ## Quick Start
@@ -597,26 +594,15 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
-## TaskIQ with RabbitMQ
-
-TaskIQ integration allows the module to scale for heavy CPU tasks by
-distributing requests to stateless worker instances.
+## Redis Gateway
 
-- **Decoupled Scalability**: RabbitMQ brokers messages, letting producers and
-  consumers scale independently.
-- **Reliability**: Durable queues, acknowledgements, and dead-lettering ensure
-  tasks aren't lost.
-- **Concurrency Control**: TaskIQ's worker pool manages parallel execution
-  without custom schedulers.
-- **Flexibility**: Built-in retries, exponential backoff, and Redis
-  result-backend for resilient workflows.
+The embedded gateway enables real-time bidirectional communication between
+modules via Redis Streams, with crash recovery and horizontal scaling.
 
-To enable RabbitMQ streaming:
+- **Durable Streaming**: Output persisted to Redis Streams — reconnection via `from_seq`.
+- **Zero-Copy Proto**: Binary proto serialization to Redis — no JSON intermediary.
+- **Horizontal Scaling**: Each module instance embeds its own gateway. Scale by adding replicas behind a load balancer.
 
-```bash
-sudo rabbitmq-plugins enable rabbitmq_stream
-task start-taskiq
-```
 
 ## Development
 
@@ -649,8 +635,6 @@ task docs-serve           # Serve docs locally (mkdocs)
 task docs-build           # Build docs
 
 task generate-certificates  # Generate mTLS certs for gRPC
-task start-taskiq           # Start TaskIQ worker
-
 task clean                # Remove build artifacts + __pycache__
 task clean-all            # Above + remove .venv
 ```

{digitalkin-0.4.2.dev1 → digitalkin-1.0.0.dev1}/README.md

@@ -26,8 +26,7 @@ communicate over gRPC, register with a service mesh, and scale independently.
 - **Profiling** — optional `[profiling]` extra with asyncio-inspector,
   pyinstrument, viztracer, and yappi
 - **Batched history writes** — efficient storage writes for conversation history
-- **TaskIQ integration** — optional distributed task execution backed by
-  RabbitMQ and Redis (`[taskiq]` extra)
+- **Redis Streams** — durable message passing, crash recovery, and reconnection
 
 ## Installation
 
@@ -42,11 +41,11 @@ pip install digitalkin
 **Optional extras:**
 
 ```bash
-# Distributed task execution (RabbitMQ + Redis)
-uv add "digitalkin[taskiq]"
-
 # Async profiling tools
 uv add "digitalkin[profiling]"
+
+# uvloop for faster event loop
+uv add "digitalkin[performance]"
 ```
 
 ## Quick Start
@@ -124,26 +123,15 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
-## TaskIQ with RabbitMQ
-
-TaskIQ integration allows the module to scale for heavy CPU tasks by
-distributing requests to stateless worker instances.
+## Redis Gateway
 
-- **Decoupled Scalability**: RabbitMQ brokers messages, letting producers and
-  consumers scale independently.
-- **Reliability**: Durable queues, acknowledgements, and dead-lettering ensure
-  tasks aren't lost.
-- **Concurrency Control**: TaskIQ's worker pool manages parallel execution
-  without custom schedulers.
-- **Flexibility**: Built-in retries, exponential backoff, and Redis
-  result-backend for resilient workflows.
+The embedded gateway enables real-time bidirectional communication between
+modules via Redis Streams, with crash recovery and horizontal scaling.
 
-To enable RabbitMQ streaming:
+- **Durable Streaming**: Output persisted to Redis Streams — reconnection via `from_seq`.
+- **Zero-Copy Proto**: Binary proto serialization to Redis — no JSON intermediary.
+- **Horizontal Scaling**: Each module instance embeds its own gateway. Scale by adding replicas behind a load balancer.
 
-```bash
-sudo rabbitmq-plugins enable rabbitmq_stream
-task start-taskiq
-```
 
 ## Development
 
@@ -176,8 +164,6 @@ task docs-serve           # Serve docs locally (mkdocs)
 task docs-build           # Build docs
 
 task generate-certificates  # Generate mTLS certs for gRPC
-task start-taskiq           # Start TaskIQ worker
-
 task clean                # Remove build artifacts + __pycache__
 task clean-all            # Above + remove .venv
 ```

digitalkin-1.0.0.dev1/examples/bench_module/echo_module.py

@@ -0,0 +1,54 @@
+"""EchoModule — a simple tool module that echoes transformed text.
+
+Mirrors the template-tool pattern: ToolModule with TriggerHandler,
+DataTrigger models, and ModuleServer with embedded gateway.
+"""
+
+from typing import Any, ClassVar
+
+from models.input import EchoInput
+from models.output import EchoOutput
+from models.secret import EchoSecret
+from models.setup import EchoSetup
+
+from digitalkin.models.module import ModuleContext
+from digitalkin.modules.tool_module import ToolModule
+from digitalkin.utils.package_discover import ModuleDiscoverer
+
+
+class EchoToolModule(ToolModule[EchoInput, EchoOutput, EchoSetup, EchoSecret]):
+    """A tool module that echoes transformed text with streaming output."""
+
+    name = "EchoToolModule"
+    description = "Echoes input text with optional transforms (uppercase, prefix, reverse, repeat)."
+
+    input_format = EchoInput
+    output_format = EchoOutput
+    setup_format = EchoSetup
+    secret_format = EchoSecret
+
+    metadata: ClassVar[dict[str, str | list[str]]] = {
+        "name": "EchoToolModule",
+        "description": "Echoes input text with transforms.",
+        "version": "1.0.0",
+        "tags": ["echo", "tool", "demo"],
+    }
+
+    services_config_strategies: ClassVar[dict[str, Any]] = {}
+    services_config_params: ClassVar[dict[str, Any]] = {
+        "storage": {"config": {}},
+        "cost": {"config": {}},
+    }
+
+    triggers_discoverer = ModuleDiscoverer(packages=["triggers"])
+
+    async def initialize(self, context: ModuleContext, setup_data: EchoSetup) -> None:
+        """Initialize module.
+
+        Args:
+            context: The module context.
+            setup_data: The setup configuration.
+        """
+
+    async def cleanup(self) -> None:
+        """Clean up resources."""

digitalkin-1.0.0.dev1/examples/bench_module/models/__init__.py

@@ -0,0 +1 @@
+"""Data models for the EchoModule."""

digitalkin-1.0.0.dev1/examples/bench_module/models/input.py

@@ -0,0 +1,20 @@
+"""Input models for the EchoModule."""
+
+from typing import Literal
+
+from pydantic import Field
+
+from digitalkin.models.module import DataModel, DataTrigger
+
+
+class MessageInputPayload(DataTrigger):
+    """Input payload for message protocol."""
+
+    protocol: Literal["message"] = "message"
+    user_prompt: str = Field(..., description="The user's input prompt")
+
+
+class EchoInput(DataModel[MessageInputPayload]):
+    """Unified input model for the EchoModule."""
+
+    root: MessageInputPayload = Field(..., discriminator="protocol")

digitalkin-1.0.0.dev1/examples/bench_module/models/output.py

@@ -0,0 +1,20 @@
+"""Output models for the EchoModule."""
+
+from typing import Literal
+
+from pydantic import Field
+
+from digitalkin.models.module import DataModel, DataTrigger
+
+
+class MessageOutputPayload(DataTrigger):
+    """Output payload for message protocol."""
+
+    protocol: Literal["message"] = "message"
+    response: str = Field(..., description="The response message")
+
+
+class EchoOutput(DataModel[MessageOutputPayload]):
+    """Unified output model for the EchoModule."""
+
+    root: MessageOutputPayload = Field(..., discriminator="protocol")

digitalkin-1.0.0.dev1/examples/bench_module/models/secret.py

@@ -0,0 +1,10 @@
+"""Secret model for the EchoModule."""
+
+from pydantic import BaseModel
+
+
+class EchoSecret(BaseModel):
+    """Secret model for the EchoModule.
+
+    This module has no secrets.
+    """

digitalkin-1.0.0.dev1/examples/bench_module/models/setup.py

@@ -0,0 +1,18 @@
+"""Setup model for the EchoModule."""
+
+from pydantic import Field
+
+from digitalkin.models.module import SetupModel
+
+
+class EchoSetup(SetupModel):
+    """Configuration model for the EchoModule.
+
+    Controls how input text is transformed before streaming back.
+    """
+
+    uppercase: bool = Field(default=False, description="Convert output to uppercase")
+    repeat: int = Field(default=1, description="Number of output chunks per input")
+    delay_ms: int = Field(default=0, description="Milliseconds between chunks")
+    prefix: str = Field(default="", description="Prepend to each output chunk")
+    reverse: bool = Field(default=False, description="Reverse the text")

digitalkin-1.0.0.dev1/examples/bench_module/server.py

@@ -0,0 +1,76 @@
+"""Benchmark module server — EchoModule with embedded Gateway.
+
+Pre-registers a default setup so LOCAL mode works without external services.
+Server config comes from env vars via ServerSettings (pydantic-settings).
+Gateway auto-enables via DIGITALKIN_REDIS_URL env var.
+"""
+
+import asyncio
+import logging
+import sys
+
+sys.path.insert(0, "/app/bench_module")
+
+import datetime
+
+from echo_module import EchoToolModule
+
+from digitalkin.grpc_servers.module_server import ModuleServer
+
+
+async def main_async() -> int:
+    """Run the benchmark module server.
+
+    Returns:
+        Exit code.
+    """
+    module_server = None
+    try:
+        module_server = ModuleServer(EchoToolModule)
+        await module_server.start_async()
+
+        # Pre-register default setup so LOCAL mode can resolve setup_id
+        if module_server.module_servicer is not None:
+            setup = module_server.module_servicer.setup
+            now = datetime.datetime.now(datetime.timezone.utc)
+            await setup.create_setup({
+                "setup_id": "setups:echo_bench",
+                "data": {
+                    "id": "setups:echo_bench",
+                    "name": "Echo Benchmark",
+                    "organisation_id": "org:bench",
+                    "owner_id": "user:bench",
+                    "module_id": "modules:echo_bench",
+                    "current_setup_version": {
+                        "id": "v1",
+                        "setup_id": "setups:echo_bench",
+                        "version": "1.0.0",
+                        "content": {"enabled": True},
+                        "creation_date": now.isoformat(),
+                    },
+                },
+            })
+            await setup.create_setup_version({
+                "setup_id": "setups:echo_bench",
+                "data": {
+                    "id": "v1",
+                    "setup_id": "setups:echo_bench",
+                    "version": "1.0.0",
+                    "content": {"enabled": True},
+                    "creation_date": now.isoformat(),
+                },
+            })
+            logging.info("Pre-registered setup: setups:echo_bench")
+
+        logging.info("Bench module server started on 0.0.0.0:50055")
+        await module_server.await_termination()
+    except KeyboardInterrupt:
+        pass
+    finally:
+        if module_server is not None and module_server.server is not None:
+            await module_server.stop_async()
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(asyncio.run(main_async()))

digitalkin-1.0.0.dev1/examples/bench_module/triggers/__init__.py

@@ -0,0 +1 @@
+"""Trigger handlers for the EchoModule."""

digitalkin-1.0.0.dev1/examples/bench_module/triggers/message_trigger.py

@@ -0,0 +1,63 @@
+"""Message trigger handler for the EchoModule."""
+
+import asyncio
+from typing import ClassVar, Literal
+
+from echo_module import EchoToolModule
+from models.input import MessageInputPayload
+from models.output import MessageOutputPayload
+from models.setup import EchoSetup
+
+from digitalkin.models.module import ModuleContext
+from digitalkin.modules.trigger_handler import TriggerHandler
+
+
+@EchoToolModule.register
+class MessageTrigger(TriggerHandler):
+    """Handles message protocol inputs — transforms and streams output chunks."""
+
+    protocol: Literal["message"] = "message"
+    description: ClassVar[str] = "Echo input text with optional transforms (uppercase, prefix, reverse, repeat)."
+    input_format = MessageInputPayload
+    output_format = MessageOutputPayload
+
+    def __init__(self, context: ModuleContext) -> None:
+        """Initialize the message trigger.
+
+        Args:
+            context: The module context.
+        """
+        self.enable_log = True
+
+    async def handle(
+        self,
+        input_data: MessageInputPayload,
+        setup_data: EchoSetup,
+        context: ModuleContext,
+    ) -> None:
+        """Transform input and stream output chunks.
+
+        Args:
+            input_data: The input data payload.
+            setup_data: The setup configuration.
+            context: The module context.
+        """
+        text = input_data.user_prompt
+        repeat = setup_data.repeat
+        delay_s = setup_data.delay_ms / 1000
+
+        for i in range(repeat):
+            result = text
+            if setup_data.reverse:
+                result = result[::-1]
+            if setup_data.uppercase:
+                result = result.upper()
+            if setup_data.prefix:
+                result = f"{setup_data.prefix}{result}"
+            chunk = f"[{i + 1}/{repeat}] {result}"
+
+            output = MessageOutputPayload(response=chunk)
+            await self.send_message(context, output)
+
+            if i < repeat - 1 and delay_s > 0:
+                await asyncio.sleep(delay_s)