digitalkin 0.2.13__py3-none-any.whl → 0.2.15__py3-none-any.whl

{digitalkin-0.2.13.dist-info → digitalkin-0.2.15.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalkin
-Version: 0.2.13
+Version: 0.2.15
 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.dist-info → digitalkin-0.2.15.dist-info}/RECORD

@@ -7,37 +7,37 @@ base_server/mock/__init__.py,sha256=YZFT-F1l_TpvJYuIPX-7kTeE1CfOjhx9YmNRXVoi-jQ,
 base_server/mock/mock_pb2.py,sha256=sETakcS3PAAm4E-hTCV1jIVaQTPEAIoVVHupB8Z_k7Y,1843
 base_server/mock/mock_pb2_grpc.py,sha256=BbOT70H6q3laKgkHfOx1QdfmCS_HxCY4wCOX84YAdG4,3180
 digitalkin/__init__.py,sha256=7LLBAba0th-3SGqcpqFO-lopWdUkVLKzLZiMtB-mW3M,162
-digitalkin/__version__.py,sha256=FYm4fUSZE0epsu7qiHq0IkVIvAs5ZzTEDWDQWZeryGs,191
+digitalkin/__version__.py,sha256=GxhXo6zJ5Xxw-pyzgpQ5JGuE2pD4yvOoWCyz8hiyjwU,191
 digitalkin/logger.py,sha256=cFbIAZHOFx3nddOssRNYLXyqUPzR4CgDR_c-5wmB-og,1685
 digitalkin/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 digitalkin/grpc_servers/__init__.py,sha256=0cJBlwipSmFdXkyH3T0i6OJ1WpAtNsZgYX7JaSnkbtg,804
 digitalkin/grpc_servers/_base_server.py,sha256=NXnnZPjJqUDWoumhEbb7EOEWB7d8XYwpQs-l97NTe4k,18647
 digitalkin/grpc_servers/module_server.py,sha256=tc4n8fu7bcMkwCI3CKkAKR4cZqyP_JTEW0lGtqsc5hs,10283
-digitalkin/grpc_servers/module_servicer.py,sha256=I6S8qDhKOwDD1tofoUhAfhN8VH6A7hAM5UAlwu91_Is,14747
+digitalkin/grpc_servers/module_servicer.py,sha256=DZ1c_3XAXt-m5I6-CGqmrQ8TAFrYCUQj8R5rqMDKeQc,18383
 digitalkin/grpc_servers/registry_server.py,sha256=StY18DKYoPKQIU1SIzgito6D4_QA1aMVddZ8O2WGlHY,2223
 digitalkin/grpc_servers/registry_servicer.py,sha256=dqsKGHZ0LnaIvGt4ipaAuigd37sbJBndT4MAT029GsY,16471
-digitalkin/grpc_servers/utils/exceptions.py,sha256=I00OM8p8up20He4dU1fiHsvdLj1DymjR_UmoeUm2MSA,785
+digitalkin/grpc_servers/utils/exceptions.py,sha256=SyOgvjggaUECYmSiqy8KJLHwHVt5IClSTxslHM-IZzI,931
 digitalkin/grpc_servers/utils/factory.py,sha256=jm6rFjiqmtSv7BIHNAOxsG9xXtSvWpx9TfzSQiX97MQ,5899
 digitalkin/grpc_servers/utils/grpc_client_wrapper.py,sha256=GXRqCTCufwWd8sVMoClnl-JpeBjgmdlSCD0a3YMU9D0,2594
 digitalkin/grpc_servers/utils/models.py,sha256=80F5oHiv8MOqMoDZJBXmJSRoVYJRyhaVcijQ2LinAig,8428
 digitalkin/grpc_servers/utils/types.py,sha256=rQ78s4nAet2jy-NIDj_PUWriT0kuGHr_w6ELjmjgBao,539
 digitalkin/models/__init__.py,sha256=hDHtUfswaNh8wo4NZaBItg9JqC0uNSRqXArNWSrGynY,163
-digitalkin/models/module/__init__.py,sha256=ihvRlemJuFvU4armZIL-Vq-zaJx9UrjDoJAVPbEG8jw,345
+digitalkin/models/module/__init__.py,sha256=iQJgq3OVvxoY6gkNCVdVz5bSGgLCy0TMY5H1FFxs-0Q,389
 digitalkin/models/module/module.py,sha256=NWOwCeD_NH0NL89AF_NJ0SwE7G1n-HTcRalodLCDmpM,749
-digitalkin/models/module/module_types.py,sha256=SxwzfDDnkyuQe50glVrxN6VPuJCkbB313FRyVZugIMw,312
+digitalkin/models/module/module_types.py,sha256=rlT6prjBN-h1sLKstSwjxWXiyFgtxEn1mjOSLgfI6uA,385
 digitalkin/models/services/__init__.py,sha256=HsW7MUGFPvH7Ri28WN4BHHBfEQk5dzU_9FOWAc-0lSE,56
 digitalkin/models/services/cost.py,sha256=QTEuFD6xz62nob0z4ksE-INJWcZ-iFiuNW5mvXhpFes,1599
 digitalkin/models/services/storage.py,sha256=cYTVIriGKiprF9OerhSxmc_jM6fUTVwmeon1yQCinkE,143
 digitalkin/modules/__init__.py,sha256=ppYARmhvdVi55ofC0QZerIempSlcJYDeCXhcl4qXObw,278
-digitalkin/modules/_base_module.py,sha256=EwfCCIy3N1eBdBUj6KAdx0WzNRFJsyQDVCdA8Lwvtn4,10463
-digitalkin/modules/archetype_module.py,sha256=T2Ehj7EpAC2MO9WQbJv39hqRw7rh3exhVZTEL3JPM8U,421
-digitalkin/modules/tool_module.py,sha256=86g0M1wHZ1ReIc7AkKfyjnlGN2QYJBGxrEQpKVlyrZI,421
-digitalkin/modules/trigger_module.py,sha256=kVoI4Gdkw7WWUP5T6hSCNqw5FxibTxL6Tpq9KP7gg78,379
-digitalkin/modules/job_manager/base_job_manager.py,sha256=I3bduyGDjCJ6RsbwQvLp_NA6ucP8MJJVoIKpEbaP9ss,4706
+digitalkin/modules/_base_module.py,sha256=wFnGGN97RNu3TJMdgMktOKdYPWmJL9WnwR120bPRXQg,12922
+digitalkin/modules/archetype_module.py,sha256=7rleVOkZfFR7TQeaq6oZXLBuRWixKsUJMOr9HfDV0T8,566
+digitalkin/modules/tool_module.py,sha256=7eWem70dEJiyoCtkGIJP4Ak2G8MzSruOjrByQMqW9-I,508
+digitalkin/modules/trigger_module.py,sha256=FNiJmG3nTG1nDqKC1XdJI8PmFNZNPs1_QrH6RX7ev2Y,475
+digitalkin/modules/job_manager/base_job_manager.py,sha256=Ku_MT7Cuf1R_qJU7SV-yHkzUhhMtmDOa8t5DyetvMxw,6177
 digitalkin/modules/job_manager/job_manager_models.py,sha256=onHy-DfInLZQveniMIWIKwTKSQjojz500JvHB54x93c,1129
-digitalkin/modules/job_manager/single_job_manager.py,sha256=Dekcnn8wb4epqGrWFAZ86YvvII553Hw0xjipgAINl4A,7745
-digitalkin/modules/job_manager/taskiq_broker.py,sha256=OnHZy-hAtVDU5FU4W9folZZKCrDrUk16VfHlfoECuiQ,5930
-digitalkin/modules/job_manager/taskiq_job_manager.py,sha256=ODqC7Snf-Flo0ugotqicrTgjFu4wgll6bUu7CM3l7ZE,7459
+digitalkin/modules/job_manager/single_job_manager.py,sha256=DkQV3-E9XqgmuC6hoYKolTX2iv9lUJ8BSCde3zk1OU8,10264
+digitalkin/modules/job_manager/taskiq_broker.py,sha256=sMXIgheOBshMiBUWUKph_5rxBHkip4rKusrrxFoa7uY,7379
+digitalkin/modules/job_manager/taskiq_job_manager.py,sha256=evcE3o51DPWzW2y4ri6DFQZNZbFJXyvFb65SibExJH8,10152
 digitalkin/services/__init__.py,sha256=LqGk_5DJy8Bzz62ajIq9jCeYNKQUIgtSCpafZk15FLc,910
 digitalkin/services/base_strategy.py,sha256=QAQnJw1BbqcYMSzwlFyhHP5juBH2WKrZzWxqDr_sDHI,638
 digitalkin/services/services_config.py,sha256=4hc7-rHgSigoS3SuV0V9FReD2Dz7XoMXcD6iMBP2KKM,7391
@@ -50,9 +50,9 @@ digitalkin/services/cost/cost_strategy.py,sha256=VhHeqi9WnE1yoDBBVp5qmqwIt5tTZHU
 digitalkin/services/cost/default_cost.py,sha256=mEd0VL_tMcGU41q0f9MFeBYeKZBenv0mIHuwgXlQ7uQ,3869
 digitalkin/services/cost/grpc_cost.py,sha256=p_5mG72N7e4bxwBOD9DNokvLtinBILiqCfllmkqpmhw,6253
 digitalkin/services/filesystem/__init__.py,sha256=BhwMl_BUvM0d65fmglkp0SVwn3RfYiUOKJgIMnOCaGM,381
-digitalkin/services/filesystem/default_filesystem.py,sha256=8pRO80GtJ3n7StNllvwsgM6vMurJso1Xj4bWBt_zbjw,7381
-digitalkin/services/filesystem/filesystem_strategy.py,sha256=g5duep7Trc_NWq9WNtCrnheVxfMUvX6vJyx4W0hwwiY,2348
-digitalkin/services/filesystem/grpc_filesystem.py,sha256=IN2HX05lzUzsE9BZdp_nhEKYV2GNLJRQLduzFh1JN-w,8326
+digitalkin/services/filesystem/default_filesystem.py,sha256=RATQqhdlujaTZNGbYtIstUSVSoahioghdzXFvv1X11Y,14771
+digitalkin/services/filesystem/filesystem_strategy.py,sha256=CJTjCz0eDikeTSFlL_YMwdHpIPxBSO9Yx3fDTgfYSTM,8405
+digitalkin/services/filesystem/grpc_filesystem.py,sha256=9Zw6SUbQNDV7B4rwgU5qG0b1v-2qBFElfLnjnpZ8qhA,12331
 digitalkin/services/identity/__init__.py,sha256=InkeyLgFYYwItx8mePA8HpfacOMWZwwuc0G4pWtKq9s,270
 digitalkin/services/identity/default_identity.py,sha256=Y2auZHrGSZTIN5D8HyjLvLcNbYFM1CNUE23x7p5VIGw,386
 digitalkin/services/identity/identity_strategy.py,sha256=skappBbds1_qa0Gr24FGrNX1N0_OYhYT1Lh7dUaAirE,429
@@ -61,7 +61,7 @@ digitalkin/services/registry/default_registry.py,sha256=VnWkF6nHpFxUKuUbZLPqzXqd
 digitalkin/services/registry/registry_strategy.py,sha256=uBXgZIv25jeXbeVO8vWvlNPxxNYu7_KiCw2PoE6AWr8,423
 digitalkin/services/setup/__init__.py,sha256=t6xcvEWqTbcRZstBFK9cESEqaZKvpW14VtYygxIqfYQ,65
 digitalkin/services/setup/default_setup.py,sha256=9VM3KwsuQcFQQ08RoOHWOE_-9BsRW0YGRtDWYTbQGdA,8246
-digitalkin/services/setup/grpc_setup.py,sha256=jLw9tfHMFhdVYXCIGC2ffx2HUgyNpgMi9G265nvkvMg,12440
+digitalkin/services/setup/grpc_setup.py,sha256=qjdED3HYZtpgeYYpiIwBWwPgB1NtoAuKmB5unNNRnVQ,12480
 digitalkin/services/setup/setup_strategy.py,sha256=ZnJ_HwWCkHCPrqKekSD5L9y3p8wMwfjQ8sj2hLZq6go,4004
 digitalkin/services/snapshot/__init__.py,sha256=Uzlnzo0CYlSpVsdiI37hW7xQk8hu3YA1fOI6O6MSzB0,270
 digitalkin/services/snapshot/default_snapshot.py,sha256=Mb8QwWRsHh9I_tN0ln_ZiFa1QCZxOVWmuVLemQOTWpc,1058
@@ -74,13 +74,14 @@ digitalkin/utils/__init__.py,sha256=sJnY-ZUgsjMfojAjONC1VN14mhgIDnzyOlGkw21rRnM,
 digitalkin/utils/arg_parser.py,sha256=nvjI1pKDY1HfS0oGcMQPtdTQcggXLtpxXMbnMxNEKRU,3109
 digitalkin/utils/development_mode_action.py,sha256=TqRuAF_A7bDD4twRB4PnZcRoNeaiAnEdxM5kvy4aoaA,1511
 digitalkin/utils/llm_ready_schema.py,sha256=JjMug_lrQllqFoanaC091VgOqwAd-_YzcpqFlS7p778,2375
-digitalkin-0.2.13.dist-info/licenses/LICENSE,sha256=Ies4HFv2r2hzDRakJYxk3Y60uDFLiG-orIgeTpstnIo,20327
+digitalkin-0.2.15.dist-info/licenses/LICENSE,sha256=Ies4HFv2r2hzDRakJYxk3Y60uDFLiG-orIgeTpstnIo,20327
 modules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-modules/cpu_intensive_module.py,sha256=LUfgd1qFJ0HfsWMapSXUivgf5KGDpANKPORbcQBUjc4,8089
-modules/minimal_llm_module.py,sha256=6cygPliUb4mroOrUo5YirZfQQ1IeOT3xUHzPpDC_0Tc,10045
-modules/storage_module.py,sha256=KJA75oxXDUxZrLfoY5KxeyI8Gm1b3DxFuFj7LGOkeaQ,6389
-modules/text_transform_module.py,sha256=Db_WbJi7_gWyoNvQEVhHQf5VurDsU-jd9LMAalG0oZY,7277
-digitalkin-0.2.13.dist-info/METADATA,sha256=CUpDclUxsamv7icPsWN-ImippAec3_EQZUGm1cQGHFQ,30577
-digitalkin-0.2.13.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-digitalkin-0.2.13.dist-info/top_level.txt,sha256=5_5e35inSM5YfWNZE21p5wGBojiVtQQML_WzbEk4BRU,31
-digitalkin-0.2.13.dist-info/RECORD,,
+modules/cpu_intensive_module.py,sha256=ejB9XPnFfA0uCuFUQbM3fy5UYfqqAlF36rv_P5Ri8ho,8363
+modules/minimal_llm_module.py,sha256=Ijld__ZnhzfLwpXD1XVkLZ7jyKZKyOFZczOpiPttJZc,11216
+modules/text_transform_module.py,sha256=bwPSnEUthZQyfLwcTLo52iAxItAoknkLh8Y3m5aywaY,7251
+services/filesystem_module.py,sha256=71Mcja8jCQqiqFHPdsIXplFIHTvgkxRhp0TRXuCfgkk,7430
+services/storage_module.py,sha256=ybTMqmvGaTrR8PqJ4FU0cwxaDjT36TskVrGoetTGmno,6955
+digitalkin-0.2.15.dist-info/METADATA,sha256=c9lkB9hRvwrBAGVvaQ-n7EQME-w-qt21ER2lutKgWbg,30580
+digitalkin-0.2.15.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+digitalkin-0.2.15.dist-info/top_level.txt,sha256=gcjqlyrZuLjIyxrOIavCQM_olpr6ND5kPKkZd2j0xGo,40
+digitalkin-0.2.15.dist-info/RECORD,,

{digitalkin-0.2.13.dist-info → digitalkin-0.2.15.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.7.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{digitalkin-0.2.13.dist-info → digitalkin-0.2.15.dist-info}/top_level.txt

@@ -1,3 +1,4 @@
 base_server
 digitalkin
 modules
+services

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"
@@ -202,7 +212,6 @@ class CPUIntensiveModule(BaseModule[CPUInput, CPUOutput, CPUSetup, CPUToolSecret
             "client_config": client_config,
         },
         "filesystem": {
-            "config": {},
             "client_config": client_config,
         },
         "cost": {

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.

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,
         },
     }

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())

{modules → 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")