digitalkin 0.2.13__tar.gz → 0.2.14__tar.gz

{digitalkin-0.2.13 → digitalkin-0.2.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalkin
-Version: 0.2.13
+Version: 0.2.14
 Summary: SDK to build kin used in DigitalKin
 Author-email: "DigitalKin.ai" <contact@digitalkin.ai>
 License: Attribution-NonCommercial-ShareAlike 4.0 International
@@ -452,36 +452,36 @@ Classifier: License :: Other/Proprietary License
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: digitalkin-proto>=0.1.10
+Requires-Dist: digitalkin-proto>=0.1.15
 Requires-Dist: grpcio-health-checking>=1.71.0
 Requires-Dist: grpcio-reflection>=1.71.0
 Requires-Dist: grpcio-status>=1.71.0
-Requires-Dist: pydantic>=2.11.4
+Requires-Dist: pydantic>=2.11.5
 Provides-Extra: dev
-Requires-Dist: typos>=1.32.0; extra == "dev"
-Requires-Dist: ruff>=0.11.9; extra == "dev"
-Requires-Dist: mypy>=1.15.0; extra == "dev"
-Requires-Dist: pyright>=1.1.400; extra == "dev"
+Requires-Dist: typos>=1.33.1; extra == "dev"
+Requires-Dist: ruff>=0.11.13; extra == "dev"
+Requires-Dist: mypy>=1.16.0; extra == "dev"
+Requires-Dist: pyright>=1.1.401; extra == "dev"
 Requires-Dist: pre-commit>=4.2.0; extra == "dev"
 Requires-Dist: bump2version>=1.0.1; extra == "dev"
 Requires-Dist: build>=1.2.2; extra == "dev"
 Requires-Dist: twine>=6.1.0; extra == "dev"
-Requires-Dist: cryptography>=44.0.3; extra == "dev"
-Requires-Dist: taskiq[reload]>=0.11.17; extra == "dev"
+Requires-Dist: cryptography>=45.0.4; extra == "dev"
 Provides-Extra: examples
 Requires-Dist: openai>=1.75.0; extra == "examples"
 Provides-Extra: tests
-Requires-Dist: freezegun>=1.5.1; extra == "tests"
+Requires-Dist: freezegun>=1.5.2; extra == "tests"
 Requires-Dist: hdrhistogram>=0.10.3; extra == "tests"
 Requires-Dist: grpcio-testing>=1.71.0; extra == "tests"
 Requires-Dist: psutil>=7.0.0; extra == "tests"
-Requires-Dist: pytest>=8.3.4; extra == "tests"
-Requires-Dist: pytest-asyncio>=0.26.0; extra == "tests"
+Requires-Dist: pytest>=8.4.0; extra == "tests"
+Requires-Dist: pytest-asyncio>=1.0.0; extra == "tests"
 Requires-Dist: pytest-cov>=6.1.0; extra == "tests"
 Provides-Extra: taskiq
-Requires-Dist: rstream>=0.20.9; extra == "taskiq"
+Requires-Dist: rstream>=0.30.0; extra == "taskiq"
 Requires-Dist: taskiq-aio-pika>=0.4.2; extra == "taskiq"
-Requires-Dist: taskiq-redis>=1.0.8; extra == "taskiq"
+Requires-Dist: taskiq-redis>=1.0.9; extra == "taskiq"
+Requires-Dist: taskiq[reload]>=0.11.17; extra == "taskiq"
 Dynamic: license-file
 
 # DigitalKin Python SDK

{digitalkin-0.2.13 → digitalkin-0.2.14}/examples/modules/cpu_intensive_module.py

@@ -127,6 +127,16 @@ class CPUOutput(BaseModel):
     )
 
 
+class CPUConfigSetup(BaseModel):
+    """Config Setup model definining data that will be pre-computed for each setup and module instance."""
+
+    files: list[str] = Field(
+        ...,
+        title="Files to embed",
+        description="List of files to embed in the setup lifecycle.",
+    )
+
+
 class CPUSetup(BaseModel):
     """Setup model defining module configuration parameters."""
 
@@ -175,7 +185,7 @@ client_config = ClientConfig(
 )
 
 
-class CPUIntensiveModule(BaseModule[CPUInput, CPUOutput, CPUSetup, CPUToolSecret]):
+class CPUIntensiveModule(BaseModule[CPUInput, CPUOutput, CPUSetup, CPUToolSecret, None]):
     """A CPU endpoint tool module module."""
 
     name = "CPUIntensiveModule"

{digitalkin-0.2.13 → digitalkin-0.2.14}/examples/modules/minimal_llm_module.py

@@ -11,7 +11,6 @@ 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
-from digitalkin.services.setup.setup_strategy import SetupData
 
 # Configure logging with clear formatting
 logging.basicConfig(
@@ -154,6 +153,16 @@ class OpenAISetup(BaseModel):
     )
 
 
+class OpenAIConfigSetup(BaseModel):
+    """Setup model defining module configuration parameters."""
+
+    rag_files: list[bytes] = Field(
+        ...,
+        title="RAG Files",
+        description="Files used for retrieval-augmented generation (RAG) with the OpenAI module.",
+    )
+
+
 class OpenAIToolSecret(BaseModel):
     """Secret model defining module configuration parameters."""
 
@@ -167,13 +176,22 @@ client_config = ClientConfig(
 )
 
 
-class OpenAIToolModule(BaseModule[OpenAIInput, OpenAIOutput, OpenAISetup, OpenAIToolSecret]):
+class OpenAIToolModule(
+    BaseModule[
+        OpenAIInput,
+        OpenAIOutput,
+        OpenAISetup,
+        OpenAIToolSecret,
+        OpenAIConfigSetup,
+    ]
+):
     """A openAI endpoint tool module module."""
 
     name = "OpenAIToolModule"
     description = "A module that interacts with OpenAI API to process text"
 
     # Define the schema formats for the module
+    config_setup_format = OpenAIConfigSetup
     input_format = OpenAIInput
     output_format = OpenAIOutput
     setup_format = OpenAISetup
@@ -205,7 +223,27 @@ class OpenAIToolModule(BaseModule[OpenAIInput, OpenAIOutput, OpenAISetup, OpenAI
         },
     }
 
-    async def initialize(self, setup_data: SetupData) -> None:
+    async def run_config_setup(
+        self,
+        config_setup_data: OpenAIConfigSetup,
+        setup_data: OpenAISetup,
+        callback: Callable,
+    ) -> None:
+        """Configure the module with additional setup data.
+
+        Args:
+            config_setup_data: Additional configuration content.
+            setup_data: Initial setup data for the module.
+            callback: Function to send output data back to the client.
+        """
+        logger.info("Configuring OpenAIToolModule with additional setup data. %s", config_setup_data)
+
+        # Here you can process config_content and update setup_data as needed
+        # For now, we just return the original setup_data
+        setup_data.developer_prompt = "| + |".join(f.decode("utf-8") for f in config_setup_data.rag_files)
+        await callback(setup_data)
+
+    async def initialize(self, setup_data: OpenAISetup) -> None:
         """Initialize the module capabilities.
 
         This method is called when the module is loaded by the server.

{digitalkin-0.2.13 → digitalkin-0.2.14}/pyproject.toml

@@ -12,7 +12,7 @@
 
     keywords = [ "digitalkin", "kin", "agent", "gprc", "sdk" ]
     # Version of the package automatically updated by bump2version (that is why it is separated)
-    version = "0.2.13"
+    version = "0.2.14"
 
     classifiers = [
         "Development Status :: 3 - Alpha",
@@ -29,41 +29,41 @@
     ]
 
     dependencies = [
-        "digitalkin-proto>=0.1.10",
+        "digitalkin-proto>=0.1.15",
         "grpcio-health-checking>=1.71.0",
         "grpcio-reflection>=1.71.0",
         "grpcio-status>=1.71.0",
-        "pydantic>=2.11.4",
+        "pydantic>=2.11.5",
     ]
 
     [project.optional-dependencies]
         dev = [
-            "typos>=1.32.0",
-            "ruff>=0.11.9",
-            "mypy>=1.15.0",
-            "pyright>=1.1.400",
+            "typos>=1.33.1",
+            "ruff>=0.11.13",
+            "mypy>=1.16.0",
+            "pyright>=1.1.401",
             "pre-commit>=4.2.0",
             "bump2version>=1.0.1",
             "build>=1.2.2",
             "twine>=6.1.0",
-            "cryptography>=44.0.3",
-            "taskiq[reload]>=0.11.17",
+            "cryptography>=45.0.4",
         ]
         examples = [ "openai>=1.75.0" ]
         tests = [
-            "freezegun>=1.5.1",
+            "freezegun>=1.5.2",
             "hdrhistogram>=0.10.3",
             "grpcio-testing>=1.71.0",
             "psutil>=7.0.0",
-            "pytest>=8.3.4",
-            "pytest-asyncio>=0.26.0",
+            "pytest>=8.4.0",
+            "pytest-asyncio>=1.0.0",
             "pytest-cov>=6.1.0",
         ]
         taskiq = [
-            "rstream>=0.20.9",
+            "rstream>=0.30.0",
             "taskiq-aio-pika>=0.4.2",
-            "taskiq-redis>=1.0.8",
-]
+            "taskiq-redis>=1.0.9",
+            "taskiq[reload]>=0.11.17",
+        ]
 
     [project.urls]
         Homepage      = "https://github.com/DigitalKin-ai/digitalkin"

{digitalkin-0.2.13 → digitalkin-0.2.14}/src/digitalkin/__version__.py

@@ -5,4 +5,4 @@ from importlib.metadata import PackageNotFoundError, version
 try:
     __version__ = version("digitalkin")
 except PackageNotFoundError:
-    __version__ = "0.2.13"
+    __version__ = "0.2.14"

{digitalkin-0.2.13 → digitalkin-0.2.14}/src/digitalkin/grpc_servers/module_servicer.py

@@ -81,6 +81,62 @@ class ModuleServicer(module_service_pb2_grpc.ModuleServiceServicer, ArgParser):
         )
         self.setup = GrpcSetup() if self.args.services_mode == ServicesMode.REMOTE else DefaultSetup()
 
+    async def ConfigSetupModule(  # noqa: N802
+        self,
+        request: lifecycle_pb2.ConfigSetupModuleRequest,
+        context: grpc.aio.ServicerContext,
+    ) -> lifecycle_pb2.ConfigSetupModuleResponse:
+        """Configure the module setup.
+
+        Args:
+            request: The configuration request.
+            context: The gRPC context.
+
+        Returns:
+            A response indicating success or failure.
+
+        Raises:
+            ServicerError: if the setup data is not returned or job creation fails.
+        """
+        logger.info("ConfigSetupVersion called for module: '%s'", self.module_class.__name__)
+        # Process the module input
+        # TODO: Secret should be used here as well
+        setup_version = request.setup_version
+        config_setup_data = self.module_class.create_config_setup_model(json_format.MessageToDict(request.content))
+        setup_version_data = self.module_class.create_setup_model(
+            json_format.MessageToDict(request.setup_version.content)
+        )
+
+        if not setup_version_data:
+            msg = "No setup data returned."
+            raise ServicerError(msg)
+
+        if not config_setup_data:
+            msg = "No config setup data returned."
+            raise ServicerError(msg)
+
+        # create a task to run the module in background
+        job_id = await self.job_manager.create_config_setup_instance_job(
+            config_setup_data,
+            setup_version_data,
+            request.mission_id,
+            setup_version.id,
+        )
+
+        if job_id is None:
+            context.set_code(grpc.StatusCode.NOT_FOUND)
+            context.set_details("Failed to create module instance")
+            return lifecycle_pb2.ConfigSetupModuleResponse(success=False)
+
+        updated_setup_data = await self.job_manager.generate_config_setup_module_response(job_id)
+        logger.warning(f"Updated setup data: {updated_setup_data=}")
+        setup_version.content = json_format.ParseDict(
+            updated_setup_data,
+            struct_pb2.Struct(),
+            ignore_unknown_fields=True,
+        )
+        return lifecycle_pb2.ConfigSetupModuleResponse(success=True, setup_version=setup_version)
+
     async def StartModule(  # noqa: N802
         self,
         request: lifecycle_pb2.StartModuleRequest,
@@ -116,7 +172,7 @@ class ModuleServicer(module_service_pb2_grpc.ModuleServiceServicer, ArgParser):
         setup_data = self.module_class.create_setup_model(setup_data_class.current_setup_version.content)
 
         # create a task to run the module in background
-        job_id = await self.job_manager.create_job(
+        job_id = await self.job_manager.create_module_instance_job(
             input_data,
             setup_data,
             mission_id=request.mission_id,
@@ -391,3 +447,39 @@ class ModuleServicer(module_service_pb2_grpc.ModuleServiceServicer, ArgParser):
             success=True,
             secret_schema=secret_format_struct,
         )
+
+    async def GetConfigSetupModule(  # noqa: N802
+        self,
+        request: information_pb2.GetConfigSetupModuleRequest,
+        context: grpc.ServicerContext,
+    ) -> information_pb2.GetConfigSetupModuleResponse:
+        """Get information about the module's setup and configuration.
+
+        Args:
+            request: The get module setup request.
+            context: The gRPC context.
+
+        Returns:
+            A response with the module's setup information.
+        """
+        logger.debug("GetConfigSetupModule called for module: '%s'", self.module_class.__name__)
+
+        # Get setup schema if available
+        try:
+            # Convert schema to proto format
+            config_setup_schema_proto = self.module_class.get_config_setup_format(llm_format=request.llm_format)
+            config_setup_format_struct = json_format.Parse(
+                text=config_setup_schema_proto,
+                message=struct_pb2.Struct(),  # pylint: disable=no-member
+                ignore_unknown_fields=True,
+            )
+        except NotImplementedError as e:
+            logger.warning(e)
+            context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+            context.set_details(e)
+            return information_pb2.GetConfigSetupModuleResponse()
+
+        return information_pb2.GetConfigSetupModuleResponse(
+            success=True,
+            config_setup_schema=config_setup_format_struct,
+        )

{digitalkin-0.2.13 → digitalkin-0.2.14}/src/digitalkin/grpc_servers/utils/exceptions.py

@@ -31,3 +31,7 @@ class ReflectionError(ServerError):
 
 class HealthCheckError(ServerError):
     """Error related to gRPC health check service."""
+
+
+class OptionalFeatureNotImplementedError(NotImplementedError):
+    """Raised when an optional feature is not implemented, but was requested."""

{digitalkin-0.2.13 → digitalkin-0.2.14}/src/digitalkin/models/module/__init__.py

@@ -2,10 +2,11 @@
 
 from digitalkin.models.module.module import Module, ModuleStatus
 from digitalkin.models.module.module_types import (
+    ConfigSetupModelT,
     InputModelT,
     OutputModelT,
     SecretModelT,
     SetupModelT,
 )
 
-__all__ = ["InputModelT", "Module", "ModuleStatus", "OutputModelT", "SecretModelT", "SetupModelT"]
+__all__ = ["ConfigSetupModelT", "InputModelT", "Module", "ModuleStatus", "OutputModelT", "SecretModelT", "SetupModelT"]

{digitalkin-0.2.13 → digitalkin-0.2.14}/src/digitalkin/models/module/module_types.py

@@ -4,6 +4,7 @@ from typing import TypeVar
 
 from pydantic import BaseModel
 
+ConfigSetupModelT = TypeVar("ConfigSetupModelT", bound=BaseModel | None)
 InputModelT = TypeVar("InputModelT", bound=BaseModel)
 OutputModelT = TypeVar("OutputModelT", bound=BaseModel)
 SetupModelT = TypeVar("SetupModelT", bound=BaseModel)

{digitalkin-0.2.13 → digitalkin-0.2.14}/src/digitalkin/modules/_base_module.py

@@ -9,8 +9,16 @@ from typing import Any, ClassVar, Generic
 
 from pydantic import BaseModel
 
+from digitalkin.grpc_servers.utils.exceptions import OptionalFeatureNotImplementedError
 from digitalkin.logger import logger
-from digitalkin.models.module import InputModelT, ModuleStatus, OutputModelT, SecretModelT, SetupModelT
+from digitalkin.models.module import (
+    ConfigSetupModelT,
+    InputModelT,
+    ModuleStatus,
+    OutputModelT,
+    SecretModelT,
+    SetupModelT,
+)
 from digitalkin.services.agent.agent_strategy import AgentStrategy
 from digitalkin.services.cost.cost_strategy import CostStrategy
 from digitalkin.services.filesystem.filesystem_strategy import FilesystemStrategy
@@ -30,11 +38,22 @@ class ModuleErrorModel(BaseModel):
     short_description: str
 
 
-class BaseModule(ABC, Generic[InputModelT, OutputModelT, SetupModelT, SecretModelT]):
+class BaseModule(
+    ABC,
+    Generic[
+        InputModelT,
+        OutputModelT,
+        SetupModelT,
+        SecretModelT,
+        ConfigSetupModelT,
+    ],
+):
     """BaseModule is the abstract base for all modules in the DigitalKin SDK."""
 
     name: str
     description: str
+
+    config_setup_format: type[ConfigSetupModelT]
     input_format: type[InputModelT]
     output_format: type[OutputModelT]
     setup_format: type[SetupModelT]
@@ -136,6 +155,23 @@ class BaseModule(ABC, Generic[InputModelT, OutputModelT, SetupModelT, SecretMode
         msg = "'%s' class does not define an 'output_format'."
         raise NotImplementedError(msg)
 
+    @classmethod
+    def get_config_setup_format(cls, *, llm_format: bool) -> str:
+        """Gets the JSON schema of the config setup format model.
+
+        Raises:
+            OptionalFeatureNotImplementedError: If the `config_setup_format` is not defined.
+
+        Returns:
+            The JSON schema of the config setup format as a string.
+        """
+        if cls.config_setup_format is not None:
+            if llm_format:
+                return json.dumps(llm_ready_schema(cls.config_setup_format), indent=2)
+            return json.dumps(cls.config_setup_format.model_json_schema(), indent=2)
+        msg = "'%s' class does not define an 'config_setup_format'."
+        raise OptionalFeatureNotImplementedError(msg)
+
     @classmethod
     def get_setup_format(cls, *, llm_format: bool) -> str:
         """Gets the JSON schema of the setup format model.
@@ -153,6 +189,18 @@ class BaseModule(ABC, Generic[InputModelT, OutputModelT, SetupModelT, SecretMode
         msg = "'%s' class does not define an 'setup_format'."
         raise NotImplementedError(msg)
 
+    @classmethod
+    def create_config_setup_model(cls, config_setup_data: dict[str, Any]) -> ConfigSetupModelT:
+        """Create the setup model from the setup data.
+
+        Args:
+            config_setup_data: The setup data to create the model from.
+
+        Returns:
+            The setup model.
+        """
+        return cls.config_setup_format(**config_setup_data)
+
     @classmethod
     def create_input_model(cls, input_data: dict[str, Any]) -> InputModelT:
         """Create the input model from the input data.
@@ -201,6 +249,21 @@ class BaseModule(ABC, Generic[InputModelT, OutputModelT, SetupModelT, SecretMode
         """
         return cls.output_format(**output_data)
 
+    @abstractmethod
+    async def run_config_setup(
+        self,
+        config_setup_data: ConfigSetupModelT,
+        setup_data: SetupModelT,
+        callback: Callable,
+    ) -> None:
+        """Run config setup the module.
+
+        Raises:
+            OptionalFeatureNotImplementedError: If the config setup feature is not implemented.
+        """
+        msg = f"'{self}' class does not define an optional 'run_config_setup' attribute."
+        raise OptionalFeatureNotImplementedError(msg)
+
     @abstractmethod
     async def initialize(self, setup_data: SetupModelT) -> None:
         """Initialize the module."""
@@ -302,3 +365,18 @@ class BaseModule(ABC, Generic[InputModelT, OutputModelT, SetupModelT, SecretMode
         except Exception:
             self._status = ModuleStatus.FAILED
             logger.exception("Error stopping module")
+
+    async def start_config_setup(
+        self,
+        config_setup_data: ConfigSetupModelT,
+        setup_data: SetupModelT,
+        callback: Callable[[OutputModelT | ModuleErrorModel], Coroutine[Any, Any, None]],
+    ) -> None:
+        """Start the module."""
+        try:
+            logger.info("Run Config Setup lifecycle")
+            self._status = ModuleStatus.RUNNING
+            await self.run_config_setup(config_setup_data, setup_data, callback)
+        except Exception:
+            self._status = ModuleStatus.FAILED
+            logger.exception("Error during module lifecyle")

{digitalkin-0.2.13 → digitalkin-0.2.14}/src/digitalkin/modules/archetype_module.py

@@ -3,8 +3,18 @@
 from abc import ABC
 
 from digitalkin.models.module import InputModelT, OutputModelT, SecretModelT, SetupModelT
+from digitalkin.models.module.module_types import ConfigSetupModelT
 from digitalkin.modules._base_module import BaseModule
 
 
-class ArchetypeModule(BaseModule[InputModelT, OutputModelT, SetupModelT, SecretModelT], ABC):
+class ArchetypeModule(
+    BaseModule[
+        InputModelT,
+        OutputModelT,
+        SetupModelT,
+        SecretModelT,
+        ConfigSetupModelT,
+    ],
+    ABC,
+):
     """ArchetypeModule extends BaseModule to implement specific module types."""

{digitalkin-0.2.13 → digitalkin-0.2.14}/src/digitalkin/modules/job_manager/base_job_manager.py

@@ -7,12 +7,13 @@ from typing import Any, Generic
 
 from digitalkin.models import ModuleStatus
 from digitalkin.models.module import InputModelT, OutputModelT, SetupModelT
+from digitalkin.models.module.module_types import ConfigSetupModelT
 from digitalkin.modules._base_module import BaseModule
 from digitalkin.services.services_config import ServicesConfig
 from digitalkin.services.services_models import ServicesMode
 
 
-class BaseJobManager(abc.ABC, Generic[InputModelT, SetupModelT]):
+class BaseJobManager(abc.ABC, Generic[InputModelT, SetupModelT, ConfigSetupModelT]):
     """Abstract base class for managing background module jobs."""
 
     async def _start(self) -> None:
@@ -82,14 +83,14 @@ class BaseJobManager(abc.ABC, Generic[InputModelT, SetupModelT]):
         """
 
     @abc.abstractmethod
-    async def create_job(
+    async def create_module_instance_job(
         self,
         input_data: InputModelT,
         setup_data: SetupModelT,
         mission_id: str,
         setup_version_id: str,
     ) -> str:
-        """Create and start a new job for the module.
+        """Create and start a new job for the module's instance.
 
         Args:
             input_data: The input data required to start the job.
@@ -101,6 +102,47 @@ class BaseJobManager(abc.ABC, Generic[InputModelT, SetupModelT]):
             str: The unique identifier (job ID) of the created job.
         """
 
+    @abc.abstractmethod
+    async def generate_config_setup_module_response(self, job_id: str) -> SetupModelT:
+        """Generate a stream consumer for a module's output data.
+
+        This method creates an asynchronous generator that streams output data
+        from a specific module job. If the module does not exist, it generates
+        an error message.
+
+        Args:
+            job_id: The unique identifier of the job.
+
+        Returns:
+            SetupModelT: the SetupModelT object fully processed.
+        """
+
+    @abc.abstractmethod
+    async def create_config_setup_instance_job(
+        self,
+        config_setup_data: ConfigSetupModelT,
+        setup_data: SetupModelT,
+        mission_id: str,
+        setup_version_id: str,
+    ) -> str:
+        """Create and start a new module job.
+
+        This method initializes a new module job, assigns it a unique job ID,
+        and starts it in the background.
+
+        Args:
+            config_setup_data: The input data required to start the job.
+            setup_data: The setup configuration for the module.
+            mission_id: The mission ID associated with the job.
+            setup_version_id: The setup ID.
+
+        Returns:
+            str: The unique identifier (job ID) of the created job.
+
+        Raises:
+            Exception: If the module fails to start.
+        """
+
     @abc.abstractmethod
     async def stop_module(self, job_id: str) -> bool:
         """Stop a running module job.