digitalkin 0.3.1.dev1__py3-none-any.whl → 0.3.2a2__py3-none-any.whl

modules/archetype_with_tools_module.py

@@ -0,0 +1,232 @@
+"""Example archetype module with tool cache integration."""
+
+import logging
+from typing import Any, ClassVar, Literal
+
+from pydantic import BaseModel, Field
+
+from digitalkin.models.grpc_servers.models import ClientConfig, SecurityMode, ServerMode
+from digitalkin.models.module.module_context import ModuleContext
+from digitalkin.models.module.setup_types import SetupModel
+from digitalkin.models.module.tool_reference import ToolReference
+from digitalkin.modules._base_module import BaseModule  # noqa: PLC2701
+from digitalkin.services.services_models import ServicesStrategy
+
+logging.basicConfig(
+    level=logging.DEBUG,
+    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+)
+logger = logging.getLogger(__name__)
+
+
+class MessageInputPayload(BaseModel):
+    """Message input payload."""
+
+    payload_type: Literal["message"] = "message"
+    user_prompt: str
+
+
+class ArchetypeInput(BaseModel):
+    """Archetype input."""
+
+    payload: MessageInputPayload = Field(discriminator="payload_type")
+
+
+class MessageOutputPayload(BaseModel):
+    """Message output payload."""
+
+    payload_type: Literal["message"] = "message"
+    response: str
+    tools_used: list[str] = Field(default_factory=list)
+
+
+class ArchetypeOutput(BaseModel):
+    """Archetype output."""
+
+    payload: MessageOutputPayload = Field(discriminator="payload_type")
+
+
+class ArchetypeSetup(SetupModel):
+    """Setup with tool references resolved during config setup."""
+
+    model_name: str = Field(
+        default="gpt-4",
+        json_schema_extra={"config": True},
+    )
+    temperature: float = Field(
+        default=0.7,
+        json_schema_extra={"config": True},
+    )
+
+    search_tool: ToolReference = Field(
+        default_factory=lambda: ToolReference(
+            module_ids=["search-tool-v1"],
+        ),
+        json_schema_extra={"config": True},
+    )
+
+    calculator_tool: ToolReference = Field(
+        default_factory=lambda: ToolReference(
+            tags=["math-calculator"],
+        ),
+        json_schema_extra={"config": True},
+    )
+
+    dynamic_tool: ToolReference = Field(
+        default_factory=lambda: ToolReference(
+            tags=["discoverable"],
+        ),
+        json_schema_extra={"config": True},
+    )
+
+    system_prompt: str = Field(
+        default="You are a helpful assistant with access to tools.",
+        json_schema_extra={"hidden": True},
+    )
+
+
+class ArchetypeConfigSetup(BaseModel):
+    """Config setup model."""
+
+    additional_instructions: str | None = None
+
+
+class ArchetypeSecret(BaseModel):
+    """Secrets model."""
+
+
+client_config = ClientConfig(
+    host="[::]",
+    port=50152,
+    mode=ServerMode.ASYNC,
+    security=SecurityMode.INSECURE,
+    credentials=None,
+)
+
+
+class ArchetypeWithToolsModule(
+    BaseModule[
+        ArchetypeInput,
+        ArchetypeOutput,
+        ArchetypeSetup,
+        ArchetypeSecret,
+    ]
+):
+    """Archetype module demonstrating tool cache usage."""
+
+    name = "ArchetypeWithToolsModule"
+    description = "Archetype with tool cache integration"
+
+    config_setup_format = ArchetypeConfigSetup
+    input_format = ArchetypeInput
+    output_format = ArchetypeOutput
+    setup_format = ArchetypeSetup
+    secret_format = ArchetypeSecret
+
+    metadata: ClassVar[dict[str, Any]] = {
+        "name": "ArchetypeWithToolsModule",
+        "version": "1.0.0",
+        "tags": ["archetype", "tools"],
+    }
+
+    services_config_strategies: ClassVar[dict[str, ServicesStrategy | None]] = {}
+    services_config_params: ClassVar[dict[str, dict[str, Any | None] | None]] = {
+        "registry": {
+            "config": {},
+            "client_config": client_config,
+        },
+    }
+
+    async def run_config_setup(
+        self,
+        context: ModuleContext,  # noqa: ARG002
+        config_setup_data: ArchetypeSetup,
+    ) -> ArchetypeSetup:
+        """Custom config setup logic, runs in parallel with tool resolution.
+
+        Args:
+            context: Module context with services.
+            config_setup_data: Setup data being configured.
+
+        Returns:
+            Configured setup data.
+        """
+        logger.info("Running config setup for %s", self.name)
+        return config_setup_data
+
+    async def initialize(self, context: ModuleContext, setup_data: ArchetypeSetup) -> None:  # noqa: ARG002
+        """Initialize module.
+
+        Args:
+            context: Module context with services and tool cache.
+            setup_data: Setup data for the module.
+        """
+        logger.info("Initializing %s", self.name)
+        if context.tool_cache:
+            logger.info("Available tools: %s", context.tool_cache.list_tools())
+
+    async def run(
+        self,
+        input_data: ArchetypeInput,
+        setup_data: ArchetypeSetup,  # noqa: ARG002
+    ) -> None:
+        """Run module with tool cache lookups and call_module_by_id.
+
+        Args:
+            input_data: Input data to process.
+            setup_data: Setup configuration.
+        """
+        logger.info("Running %s", self.name)
+
+        tools_used: list[str] = []
+        tool_results: list[str] = []
+
+        # Get search tool from cache and call via call_module_by_id
+        search_info = self.context.tool_cache.get("search_tool")
+        if search_info:
+            tools_used.append(f"search:{search_info.module_id}")
+            async for response in self.context.call_module_by_id(
+                module_id=search_info.module_id,
+                input_data={"query": input_data.payload.user_prompt},
+                setup_id=self.context.session.setup_id,
+                mission_id=self.context.session.mission_id,
+            ):
+                tool_results.append(f"search_result: {response}")
+
+        # Get calculator tool from cache
+        calc_info = self.context.tool_cache.get("calculator_tool")
+        if calc_info:
+            tools_used.append(f"calculator:{calc_info.module_id}")
+            async for response in self.context.call_module_by_id(
+                module_id=calc_info.module_id,
+                input_data={"expression": "2 + 2"},
+                setup_id=self.context.session.setup_id,
+                mission_id=self.context.session.mission_id,
+            ):
+                tool_results.append(f"calc_result: {response}")
+
+        # Dynamic discovery via registry fallback for tools not in cache
+        dynamic_info = self.context.tool_cache.get(
+            "some_dynamic_tool",
+            registry=self.context.registry,
+        )
+        if dynamic_info:
+            tools_used.append(f"dynamic:{dynamic_info.module_id}")
+            async for response in self.context.call_module_by_id(
+                module_id=dynamic_info.module_id,
+                input_data={"prompt": input_data.payload.user_prompt},
+                setup_id=self.context.session.setup_id,
+                mission_id=self.context.session.mission_id,
+            ):
+                tool_results.append(f"dynamic_result: {response}")
+
+        response = MessageOutputPayload(
+            response=f"Processed: {input_data.payload.user_prompt} | Results: {len(tool_results)}",
+            tools_used=tools_used,
+        )
+
+        await self.context.callbacks.send_message(ArchetypeOutput(payload=response))
+
+    async def cleanup(self) -> None:
+        """Clean up resources."""
+        logger.info("Cleaning up %s", self.name)

modules/cpu_intensive_module.py

@@ -4,9 +4,9 @@ import logging
 from collections.abc import Callable
 from typing import Any, ClassVar, Literal
 
+from digitalkin.grpc_servers.utils.models import ClientConfig, SecurityMode, ServerConfig, ServerMode
 from pydantic import BaseModel, Field
 
-from digitalkin.grpc_servers.utils.models import ClientConfig, SecurityMode, ServerConfig, ServerMode
 from digitalkin.modules._base_module import BaseModule
 from digitalkin.services.services_models import ServicesStrategy
 from digitalkin.services.setup.setup_strategy import SetupData

modules/dynamic_setup_module.py

@@ -0,0 +1,338 @@
+"""Example module demonstrating dynamic schema fields in SetupModel.
+
+This example shows how to use the Dynamic metadata class with async fetchers
+to populate field schemas (like enums) at runtime. This is useful when the
+available options come from external sources like databases or APIs.
+
+Usage:
+    # Start the module server
+    python examples/modules/dynamic_setup_module.py
+
+    # Or import and use in your own code
+    from examples.modules.dynamic_setup_module import DynamicSetupModule
+"""
+
+import asyncio
+import logging
+from typing import Annotated, Any, ClassVar
+
+from pydantic import BaseModel, Field
+
+from digitalkin.models.module.module_context import ModuleContext
+from digitalkin.models.module.module_types import DataModel, DataTrigger, SetupModel
+from digitalkin.modules._base_module import BaseModule
+from digitalkin.services.services_models import ServicesStrategy
+from digitalkin.utils import Dynamic
+
+# Configure logging
+logging.basicConfig(
+    level=logging.DEBUG,
+    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+)
+logger = logging.getLogger(__name__)
+
+
+# =============================================================================
+# Simulated External Services (replace with real implementations)
+# =============================================================================
+
+
+class MockModelRegistry:
+    """Simulates an external model registry service.
+
+    In a real application, this would be a connection to a database,
+    API service, or configuration management system.
+    """
+
+    _models: ClassVar[list[str]] = ["gpt-4", "gpt-4-turbo", "gpt-3.5-turbo"]
+    _languages: ClassVar[list[str]] = ["en", "fr", "de", "es", "it", "pt"]
+
+    @classmethod
+    async def fetch_available_models(cls) -> list[str]:
+        """Fetch available models from the registry.
+
+        Simulates an async API call with a small delay.
+        """
+        await asyncio.sleep(0.1)  # Simulate network latency
+        logger.info("Fetched %d models from registry", len(cls._models))
+        return cls._models.copy()
+
+    @classmethod
+    async def fetch_supported_languages(cls) -> list[str]:
+        """Fetch supported languages from the registry."""
+        await asyncio.sleep(0.05)  # Simulate network latency
+        logger.info("Fetched %d languages from registry", len(cls._languages))
+        return cls._languages.copy()
+
+    @classmethod
+    def get_default_model(cls) -> str:
+        """Get the default model (sync fetcher example)."""
+        return cls._models[0] if cls._models else "gpt-4"
+
+
+# =============================================================================
+# Dynamic Fetcher Functions
+# =============================================================================
+
+
+async def fetch_models() -> list[str]:
+    """Async fetcher for available model names.
+
+    This function is called when SetupModel.get_clean_model(force=True)
+    is invoked, typically during module initialization or schema refresh.
+    """
+    return await MockModelRegistry.fetch_available_models()
+
+
+async def fetch_languages() -> list[str]:
+    """Async fetcher for supported languages."""
+    return await MockModelRegistry.fetch_supported_languages()
+
+
+def get_temperature_range() -> dict[str, float]:
+    """Sync fetcher example returning min/max for temperature.
+
+    Demonstrates that fetchers can return any JSON-serializable value,
+    not just lists for enums.
+    """
+    return {"minimum": 0.0, "maximum": 2.0}
+
+
+# =============================================================================
+# Setup Model with Dynamic Fields
+# =============================================================================
+
+
+class DynamicAgentSetup(SetupModel):
+    """Setup model demonstrating dynamic schema fields.
+
+    Fields marked with Dynamic(...) will have their schema values
+    refreshed at runtime when get_clean_model(force=True) is called.
+
+    Attributes:
+        model_name: The LLM model to use. Enum values fetched from registry.
+        language: Output language. Enum values fetched dynamically.
+        temperature: Sampling temperature. Static field for comparison.
+        max_tokens: Maximum tokens to generate.
+        system_prompt: The system prompt for the model.
+    """
+
+    # Dynamic field: enum values fetched asynchronously from model registry
+    model_name: Annotated[str, Dynamic(enum=fetch_models)] = Field(
+        default="gpt-4",
+        title="Model Name",
+        description="The LLM model to use for generation.",
+        json_schema_extra={
+            "config": True,  # Shown in initial configuration
+            "ui:widget": "select",
+        },
+    )
+
+    # Dynamic field: language options fetched asynchronously
+    language: Annotated[str, Dynamic(enum=fetch_languages)] = Field(
+        default="en",
+        title="Output Language",
+        description="The language for generated responses.",
+        json_schema_extra={
+            "config": True,
+            "ui:widget": "select",
+        },
+    )
+
+    # Static field: no dynamic fetcher, values defined at class time
+    temperature: float = Field(
+        default=0.7,
+        ge=0.0,
+        le=2.0,
+        title="Temperature",
+        description="Controls randomness. Higher values = more creative.",
+        json_schema_extra={"config": True},
+    )
+
+    # Static field with hidden flag (runtime-only, not in initial config)
+    max_tokens: int = Field(
+        default=1024,
+        ge=1,
+        le=4096,
+        title="Max Tokens",
+        description="Maximum tokens in the response.",
+        json_schema_extra={"hidden": True},
+    )
+
+    # Static field without any special flags
+    system_prompt: str = Field(
+        default="You are a helpful assistant.",
+        title="System Prompt",
+        description="The system prompt defining assistant behavior.",
+    )
+
+
+# =============================================================================
+# Input/Output Models (Using DataModel/DataTrigger pattern)
+# =============================================================================
+
+
+class MessageInputTrigger(DataTrigger):
+    """Message input trigger following DigitalKin DataTrigger pattern.
+
+    The protocol field determines which trigger handler processes this input.
+    """
+
+    protocol: str = "message"
+    content: str = Field(default="", description="The user message content.")
+
+
+class DynamicModuleInput(DataModel[MessageInputTrigger]):
+    """Input model following DigitalKin DataModel pattern.
+
+    Wraps the trigger in a root field with optional annotations.
+    """
+
+    root: MessageInputTrigger = Field(default_factory=MessageInputTrigger)
+
+
+class MessageOutputTrigger(DataTrigger):
+    """Message output trigger following DigitalKin DataTrigger pattern."""
+
+    protocol: str = "message"
+    content: str = Field(default="", description="The generated response.")
+    model_used: str = Field(default="", description="The model that generated this response.")
+    language: str = Field(default="", description="The output language.")
+
+
+class DynamicModuleOutput(DataModel[MessageOutputTrigger]):
+    """Output model following DigitalKin DataModel pattern."""
+
+    root: MessageOutputTrigger = Field(default_factory=MessageOutputTrigger)
+
+
+class DynamicModuleSecret(BaseModel):
+    """Secret model (empty for this example)."""
+
+
+# =============================================================================
+# Module Implementation
+# =============================================================================
+
+
+class DynamicSetupModule(
+    BaseModule[
+        DynamicModuleInput,
+        DynamicModuleOutput,
+        DynamicAgentSetup,
+        DynamicModuleSecret,
+    ]
+):
+    """Example module demonstrating dynamic schema in SetupModel.
+
+    This module shows how to:
+    1. Define setup fields with Dynamic() metadata for runtime enum fetching
+    2. Mix static and dynamic fields in the same SetupModel
+    3. Use async fetchers that simulate external service calls
+    4. Follow DigitalKin's DataModel/DataTrigger pattern for I/O
+
+    The key integration point is in the gRPC servicer, which calls
+    SetupModel.get_clean_model(force=True) to refresh dynamic values
+    before returning schema information to clients.
+    """
+
+    name = "DynamicSetupModule"
+    description = "Demonstrates dynamic schema fields in module setup"
+
+    # Schema format definitions
+    input_format = DynamicModuleInput
+    output_format = DynamicModuleOutput
+    setup_format = DynamicAgentSetup
+    secret_format = DynamicModuleSecret
+
+    # Module metadata
+    metadata: ClassVar[dict[str, Any]] = {
+        "name": "DynamicSetupModule",
+        "description": "Example module with dynamic setup schema",
+        "version": "1.0.0",
+        "tags": ["example", "dynamic-schema"],
+    }
+
+    # Services configuration (empty for this example)
+    services_config_strategies: ClassVar[dict[str, ServicesStrategy | None]] = {}
+    services_config_params: ClassVar[dict[str, dict[str, Any | None] | None]] = {}
+
+    async def initialize(self, context: ModuleContext, setup_data: DynamicAgentSetup) -> None:
+        """Initialize the module with setup data.
+
+        Args:
+            context: The module context with services and session info.
+            setup_data: The validated setup configuration.
+        """
+        logger.info(
+            "Initializing DynamicSetupModule with model=%s, language=%s",
+            setup_data.model_name,
+            setup_data.language,
+        )
+        self.setup = setup_data
+
+    async def cleanup(self) -> None:
+        """Clean up resources."""
+        logger.info("Cleaning up DynamicSetupModule")
+
+
+# =============================================================================
+# Demonstration Script
+# =============================================================================
+
+
+async def demonstrate_dynamic_schema() -> None:
+    """Demonstrate the dynamic schema functionality."""
+    # 1. Show schema WITHOUT force (dynamic fields not resolved)
+
+    model_no_force = await DynamicAgentSetup.get_clean_model(
+        config_fields=True,
+        hidden_fields=False,
+        force=False,
+    )
+    schema_no_force = model_no_force.model_json_schema()
+
+    # Check if enum is present
+    model_name_schema = schema_no_force.get("properties", {}).get("model_name", {})
+    if "enum" in model_name_schema:
+        pass
+
+    # 2. Show schema WITH force (dynamic fields resolved)
+
+    model_with_force = await DynamicAgentSetup.get_clean_model(
+        config_fields=True,
+        hidden_fields=False,
+        force=True,
+    )
+    schema_with_force = model_with_force.model_json_schema()
+
+    # Check enum values after force
+    model_name_schema = schema_with_force.get("properties", {}).get("model_name", {})
+    if "enum" in model_name_schema:
+        pass
+
+    language_schema = schema_with_force.get("properties", {}).get("language", {})
+    if "enum" in language_schema:
+        pass
+
+    # 3. Show that static json_schema_extra is preserved
+
+    # 4. Show field filtering
+
+    # Config fields only (hidden excluded)
+    await DynamicAgentSetup.get_clean_model(
+        config_fields=True,
+        hidden_fields=False,
+        force=False,
+    )
+
+    # All fields including hidden
+    await DynamicAgentSetup.get_clean_model(
+        config_fields=True,
+        hidden_fields=True,
+        force=False,
+    )
+
+
+if __name__ == "__main__":
+    asyncio.run(demonstrate_dynamic_schema())

modules/minimal_llm_module.py

@@ -6,9 +6,9 @@ from collections.abc import Callable
 from typing import Any, ClassVar, Literal
 
 import openai
+from digitalkin.grpc_servers.utils.models import ClientConfig, SecurityMode, ServerMode
 from pydantic import BaseModel, Field
 
-from digitalkin.grpc_servers.utils.models import ClientConfig, SecurityMode, ServerMode
 from digitalkin.modules._base_module import BaseModule
 from digitalkin.services.services_models import ServicesStrategy
 

modules/text_transform_module.py

@@ -4,9 +4,9 @@ import logging
 from collections.abc import Callable
 from typing import Any, ClassVar
 
+from digitalkin.grpc_servers.utils.models import ClientConfig, SecurityMode, ServerMode
 from pydantic import BaseModel
 
-from digitalkin.grpc_servers.utils.models import ClientConfig, SecurityMode, ServerMode
 from digitalkin.modules._base_module import BaseModule
 from digitalkin.services.setup.setup_strategy import SetupData
 from digitalkin.services.storage.storage_strategy import DataType, StorageRecord

monitoring/digitalkin_observability/__init__.py

@@ -0,0 +1,46 @@
+"""Standalone observability module for DigitalKin.
+
+This module can be copied into your project and used independently.
+It has no dependencies on the digitalkin package.
+
+Usage:
+    from digitalkin_observability import (
+        MetricsCollector,
+        MetricsServer,
+        MetricsServerInterceptor,
+        PrometheusExporter,
+        get_metrics,
+        start_metrics_server,
+        stop_metrics_server,
+    )
+
+    # Start metrics HTTP server
+    start_metrics_server(port=8081)
+
+    # Track metrics
+    metrics = get_metrics()
+    metrics.inc_jobs_started("my_module")
+    metrics.inc_jobs_completed("my_module", duration=1.5)
+
+    # Export to Prometheus format
+    print(PrometheusExporter.export())
+"""
+
+from digitalkin_observability.http_server import (
+    MetricsServer,
+    start_metrics_server,
+    stop_metrics_server,
+)
+from digitalkin_observability.interceptors import MetricsServerInterceptor
+from digitalkin_observability.metrics import MetricsCollector, get_metrics
+from digitalkin_observability.prometheus import PrometheusExporter
+
+__all__ = [
+    "MetricsCollector",
+    "MetricsServer",
+    "MetricsServerInterceptor",
+    "PrometheusExporter",
+    "get_metrics",
+    "start_metrics_server",
+    "stop_metrics_server",
+]