digitalkin 0.2.14__tar.gz → 0.2.16__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalkin
-Version: 0.2.14
+Version: 0.2.16
 Summary: SDK to build kin used in DigitalKin
 Author-email: "DigitalKin.ai" <contact@digitalkin.ai>
 License: Attribution-NonCommercial-ShareAlike 4.0 International

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

@@ -212,7 +212,6 @@ class CPUIntensiveModule(BaseModule[CPUInput, CPUOutput, CPUSetup, CPUToolSecret
             "client_config": client_config,
         },
         "filesystem": {
-            "config": {},
             "client_config": client_config,
         },
         "cost": {

{digitalkin-0.2.14 → digitalkin-0.2.16}/examples/modules/text_transform_module.py

@@ -93,7 +93,6 @@ class TextTransformModule(BaseModule[TextTransformInput, TextTransformOutput, Te
             "client_config": client_config,
         },
         "filesystem": {
-            "config": {},
             "client_config": client_config,
         },
     }

digitalkin-0.2.16/examples/services/filesystem_module.py

@@ -0,0 +1,198 @@
+"""Example module implementation to test ArchetypeModule functionality."""
+
+import asyncio
+import datetime
+from collections.abc import Callable
+from typing import TYPE_CHECKING, Any
+
+from pydantic import BaseModel, Field
+
+from digitalkin.logger import logger
+from digitalkin.models.module import ModuleStatus
+from digitalkin.modules.archetype_module import ArchetypeModule
+from digitalkin.services.services_config import ServicesConfig
+from digitalkin.services.services_models import ServicesMode
+from digitalkin.services.filesystem.filesystem_strategy import FilesystemRecord, FileFilter, UploadFileData
+
+
+class ExampleInput(BaseModel):
+    """Input model for example module."""
+
+    message: str = Field(description="Message to process")
+    number: int = Field(description="Number to process")
+
+
+class ExampleOutput(BaseModel):
+    """Output model for example module."""
+
+    processed_message: str = Field(description="The processed message")
+    processed_number: int = Field(description="The processed number")
+    timestamp: datetime.datetime = Field(description="When the processing was done")
+
+
+class ExampleSetup(BaseModel):
+    """Setup model for example module."""
+
+    processing_mode: str = Field(description="Mode to process data in", default="default")
+    multiply_factor: int = Field(description="Factor to multiply number by", default=1)
+
+
+class ExampleSecret(BaseModel):
+    """Secret model for example module."""
+
+    api_key: str = Field(description="API key for external service")
+
+
+class ExampleStorage(BaseModel):
+    """Secret model for example module."""
+
+    test_key: str = Field(description="Test value for storage")
+
+
+class ExampleModule(ArchetypeModule[ExampleInput, ExampleOutput, ExampleSetup, ExampleSecret, None]):
+    """Example module that demonstrates ArchetypeModule functionality."""
+
+    name = "ExampleModule"
+    description = "An example module for testing purposes"
+    input_format = ExampleInput
+    output_format = ExampleOutput
+    setup_format = ExampleSetup
+    secret_format = ExampleSecret
+    metadata = {"name": "ExampleModule", "description": "A module for testing ArchetypeModule functionality"}
+
+    # Define services_config_params with default values
+    services_config_strategies = {}
+    services_config_params = {"cost": {"config": {}}, "storage": {"config": {}}} # Filesystem has no config but it's enabled
+
+    def __init__(self, job_id: str, mission_id: str, setup_version_id: str) -> None:
+        """Initialize the example module.
+
+        Args:
+            job_id: Unique identifier for the job
+            name: Optional name for the module
+        """
+        # Initialize services configuration using the class attribute before the instance is created
+        self.services_config = ServicesConfig(
+            services_config_strategies=self.services_config_strategies,
+            services_config_params=self.services_config_params,
+            mode=ServicesMode.LOCAL,
+        )
+
+        super().__init__(job_id, mission_id, setup_version_id)
+
+    async def initialize(self, setup_data: ExampleSetup) -> None:
+        """Initialize the module.
+
+        Args:
+            setup_data: Setup data for the module
+        """
+        logger.info("Initializing ExampleModule with setup data: %s", setup_data)
+        self.setup = self.setup_format.model_validate(setup_data)
+        logger.info("Initialization complete, using processing mode: [%s]", self.setup.processing_mode)
+
+    async def run(
+        self,
+        input_data: dict[str, Any],
+        setup_data: ExampleSetup,
+        callback: Callable,
+    ) -> None:
+        """Run the module.
+
+        Args:
+            input_data: Input data for the module
+            setup_data: Setup data for the module
+            callback: Callback function to report progress
+        """
+        # Validate the input data
+        input_model = self.input_format.model_validate(input_data)
+        logger.info("Running with input data: %s", input_model)
+
+        # Process the data
+        processed_message = f"Processed: {input_model.message}"
+        processed_number = input_model.number * self.setup.multiply_factor
+
+        # Create output model
+        file = UploadFileData(
+            content=b"%s\n%s" % (processed_message.encode(), str(processed_number).encode()),
+            name="example_output.txt",
+            file_type="text/plain",
+            content_type="text/plain",
+            metadata={"example_key": "example_value"},
+            replace_if_exists=True,
+        )
+
+        records, uploaded, failed = self.filesystem.upload_files(files=[file])
+        for record in records:
+            logger.info("Uploaded file: %s, uploaded: %d, failed: %d", record, uploaded, failed)
+            logger.info("Stored file with ID: %s", record.id)
+            callback(record.model_dump())
+        # Call the callback with the output data
+
+
+        # Wait a bit to simulate processing time
+        await asyncio.sleep(1)
+
+    async def run_config_setup(
+        self,
+        setup_data: ExampleSetup,
+    ) -> None:
+        """Run the configuration setup for the module.
+
+        Args:
+            setup_data: Setup data for the module
+        """
+        logger.info("Running config setup with data: %s", setup_data)
+        # Here we could implement any additional configuration logic if needed
+
+    async def cleanup(self) -> None:
+        """Clean up the module."""
+        logger.info("Cleaning up ExampleModule")
+        # Nothing to clean up in this example
+
+
+async def test_module() -> None:
+    """Test the example module."""
+    # Create the module
+    module = ExampleModule(job_id="test-job-123", mission_id="test-mission-123", setup_version_id="test-setup-123")
+
+    # Define input and setup data
+    input_data = ExampleInput(message="Hello, world!", number=42)
+
+    setup_data = ExampleSetup(processing_mode="test", multiply_factor=10)
+
+    # Define a callback function
+    def callback(result) -> None:
+        logger.info(f"callback {result}")
+
+    # Start the module
+    await module.start(input_data, setup_data, callback)
+
+    # Wait for the module to complete
+    while module.status not in {ModuleStatus.STOPPED, ModuleStatus.FAILED}:
+        await asyncio.sleep(0.5)
+
+    # Check the storage
+    if module.status == ModuleStatus.STOPPED:
+        files, nb_results = module.filesystem.get_files(
+            filters=FileFilter(name="example_output.txt", context="test-mission-123"),
+        )
+        for file in files:
+            module.filesystem.update_file(file.id, file_type="updated")
+            # module.filesystem.delete_files(filters=FileFilter(name="example_output.txt", context="test-mission-123"), permanent=True)
+
+            logger.info("Retrieved file: %s with ID: %s", file.name, file.id)
+            try:
+                file_record = module.filesystem.get_file(file_id=file.id, include_content=True)
+                if file_record:
+                    logger.info("File ID: %s", file_record.id)
+                    logger.info("File name: %s", file_record.name)
+                    logger.info("File type: %s", file_record.file_type)
+                    logger.info("File status: %s", file_record.status)
+                    logger.info("File content: %s", file_record.content.decode())
+            except Exception:
+                logger.error("No file retrieved")
+
+
+if __name__ == "__main__":
+    # Run the module test
+    asyncio.run(test_module())

{digitalkin-0.2.14/examples/modules → digitalkin-0.2.16/examples/services}/storage_module.py

@@ -51,7 +51,7 @@ class ExampleStorage(BaseModel):
     test_key: str = Field(description="Test value for storage")
 
 
-class ExampleModule(ArchetypeModule[ExampleInput, ExampleOutput, ExampleSetup, ExampleSecret]):
+class ExampleModule(ArchetypeModule[ExampleInput, ExampleOutput, ExampleSetup, ExampleSecret, None]):
     """Example module that demonstrates ArchetypeModule functionality."""
 
     name = "ExampleModule"
@@ -64,14 +64,15 @@ class ExampleModule(ArchetypeModule[ExampleInput, ExampleOutput, ExampleSetup, E
 
     # Define services_config_params with default values
     services_config_strategies = {}
-    services_config_params = {"storage": {"config": {"example": ExampleOutput}}, "filesystem": {"config": {}}}
+    services_config_params = {"storage": {"config": {"example": ExampleOutput}},"cost": {"config":{}}}
 
-    def __init__(self, job_id: str, mission_id: str) -> None:
+    def __init__(self, job_id: str, mission_id: str, setup_version_id: str) -> None:
         """Initialize the example module.
 
         Args:
             job_id: Unique identifier for the job
-            name: Optional name for the module
+            mission_id: Unique identifier for the mission
+            setup_version_id: Unique identifier for the setup version
         """
         # Initialize services configuration using the class attribute before the instance is created
         self.services_config = ServicesConfig(
@@ -80,7 +81,7 @@ class ExampleModule(ArchetypeModule[ExampleInput, ExampleOutput, ExampleSetup, E
             mode=ServicesMode.LOCAL,
         )
 
-        super().__init__(job_id, mission_id)
+        super().__init__(job_id, mission_id, setup_version_id)
 
     async def initialize(self, setup_data: ExampleSetup) -> None:
         """Initialize the module.
@@ -92,6 +93,18 @@ class ExampleModule(ArchetypeModule[ExampleInput, ExampleOutput, ExampleSetup, E
         self.setup = self.setup_format.model_validate(setup_data)
         logger.info("Initialization complete, using processing mode: [%s]", self.setup.processing_mode)
 
+    async def run_config_setup(
+        self,
+        setup_data: ExampleSetup,
+    ) -> None:
+        """Run the configuration setup for the module.
+
+        Args:
+            setup_data: Setup data for the module
+        """
+        logger.info("Running config setup with data: %s", setup_data)
+        # Here we could implement any additional configuration logic if needed
+
     async def run(
         self,
         input_data: dict[str, Any],
@@ -142,7 +155,7 @@ class ExampleModule(ArchetypeModule[ExampleInput, ExampleOutput, ExampleSetup, E
 async def test_module() -> None:
     """Test the example module."""
     # Create the module
-    module = ExampleModule(job_id="test-job-123", mission_id="test-mission-123")
+    module = ExampleModule(job_id="test-job-123", mission_id="test-mission-123", setup_version_id="test-setup-123")
 
     # Define input and setup data
     input_data = ExampleInput(message="Hello, world!", number=42)
@@ -171,7 +184,7 @@ async def test_module() -> None:
 def test_storage_directly() -> None:
     """Test the storage service directly."""
     # Initialize storage service
-    storage = ServicesConfig().storage(mission_id="test-mission", config={"example": ExampleStorage})
+    storage = ServicesConfig().storage(mission_id="test-mission",setup_version_id="test-setup-123", config={"example": ExampleStorage})
 
     # Create a test record
     storage.store("example", "test_table", {"test_key": "test_value"}, "OUTPUT")

{digitalkin-0.2.14 → digitalkin-0.2.16}/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.14"
+    version = "0.2.16"
 
     classifiers = [
         "Development Status :: 3 - Alpha",
@@ -115,8 +115,8 @@
         "tool_module.py",
         "trigger_module.py",
         "generate_certificates.py",
-        "test_*.py",
-        "tests/*",
+        # "test_*.py",
+        # "tests/*",
         "examples/*",
     ]
     preview = true
@@ -186,9 +186,33 @@
                 "TRY002",
                 "FBT001",
                 "FBT002",
+                "ANN001",
                 "ANN003",
                 "ANN002",
                 "ARG002",
+                "PLR0914",
+                "PLR2004",
+                "PLR0915",
+                "PLR1702",
+                "D417",
+                "ARG001",
+                "D103",
+                "D102",
+                "D101",
+                "D107",
+                "N802",
+                "DOC201",
+                "DOC501",
+                "PERF203",
+                "C901",
+                "PLR0911",
+                "G004",
+                "ERA001",
+                "E501",
+                "ANN401",
+                "PLR0912",
+                "ANN201",
+                "D100"
             ]
 
         [tool.ruff.lint.pylint]

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

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