moose-lib 0.4.162__py3-none-any.whl → 0.4.164__py3-none-any.whl

moose_lib/dmv2.py

@@ -122,12 +122,14 @@ class OlapConfig(BaseModel):
                      setting `engine=ClickHouseEngines.ReplacingMergeTree`.
         engine: The ClickHouse table engine to use (e.g., MergeTree, ReplacingMergeTree).
         version: Optional version string for tracking configuration changes.
+        metadata: Optional metadata for the table.
     """
     order_by_fields: list[str] = []
     # equivalent to setting `engine=ClickHouseEngines.ReplacingMergeTree`
     deduplicate: bool = False
     engine: Optional[ClickHouseEngines] = None
     version: Optional[str] = None
+    metadata: Optional[dict] = None
 
 
 class OlapTable(TypedMooseResource, Generic[T]):
@@ -152,6 +154,7 @@ class OlapTable(TypedMooseResource, Generic[T]):
         super().__init__()
         self._set_type(name, self._get_type(kwargs))
         self.config = config
+        self.metadata = config.metadata
         _tables[name] = self
 
 
@@ -163,11 +166,13 @@ class StreamConfig(BaseModel):
         retention_period: Data retention period in seconds (default: 7 days).
         destination: Optional `OlapTable` where stream messages should be automatically ingested.
         version: Optional version string for tracking configuration changes.
+        metadata: Optional metadata for the stream.
     """
     parallelism: int = 1
     retention_period: int = 60 * 60 * 24 * 7  # 7 days
     destination: Optional[OlapTable[Any]] = None
     version: Optional[str] = None
+    metadata: Optional[dict] = None
 
 
 class TransformConfig(BaseModel):
@@ -180,6 +185,7 @@ class TransformConfig(BaseModel):
     version: Optional[str] = None
     dead_letter_queue: "Optional[DeadLetterQueue]" = None
     model_config = ConfigDict(arbitrary_types_allowed=True)
+    metadata: Optional[dict] = None
 
 
 class ConsumerConfig(BaseModel):
@@ -244,6 +250,7 @@ class Stream(TypedMooseResource, Generic[T]):
         super().__init__()
         self._set_type(name, self._get_type(kwargs))
         self.config = config
+        self.metadata = config.metadata
         self.consumers = []
         self.transformations = {}
         _streams[name] = self
@@ -399,8 +406,10 @@ class IngestConfig(BaseModel):
 
     Attributes:
         version: Optional version string.
+        metadata: Optional metadata for the ingestion point.
     """
     version: Optional[str] = None
+    metadata: Optional[dict] = None
 
 
 @dataclasses.dataclass
@@ -410,9 +419,11 @@ class IngestConfigWithDestination[T: BaseModel]:
     Attributes:
         destination: The `Stream` where ingested data will be sent.
         version: Optional version string.
+        metadata: Optional metadata for the ingestion configuration.
     """
     destination: Stream[T]
     version: Optional[str] = None
+    metadata: Optional[dict] = None
 
 
 class IngestPipelineConfig(BaseModel):
@@ -427,11 +438,13 @@ class IngestPipelineConfig(BaseModel):
         stream: Configuration for the stream component.
         ingest: Configuration for the ingest API component.
         version: Optional version string applied to all created components.
+        metadata: Optional metadata for the ingestion pipeline.
     """
     table: bool | OlapConfig = True
     stream: bool | StreamConfig = True
     ingest: bool | IngestConfig = True
     version: Optional[str] = None
+    metadata: Optional[dict] = None
 
 
 class IngestApi(TypedMooseResource, Generic[T]):
@@ -458,6 +471,7 @@ class IngestApi(TypedMooseResource, Generic[T]):
         super().__init__()
         self._set_type(name, self._get_type(kwargs))
         self.config = config
+        self.metadata = getattr(config, 'metadata', None)
         _ingest_apis[name] = self
 
 
@@ -527,10 +541,15 @@ class IngestPipeline(TypedMooseResource, Generic[T]):
     def __init__(self, name: str, config: IngestPipelineConfig, **kwargs):
         super().__init__()
         self._set_type(name, self._get_type(kwargs))
+        self.metadata = config.metadata
+        table_metadata = config.metadata
+        stream_metadata = config.metadata
+        ingest_metadata = config.metadata
         if config.table:
             table_config = OlapConfig() if config.table is True else config.table
             if config.version:
                 table_config.version = config.version
+            table_config.metadata = table_metadata
             self.table = OlapTable(name, table_config, t=self._t)
         if config.stream:
             stream_config = StreamConfig() if config.stream is True else config.stream
@@ -539,6 +558,7 @@ class IngestPipeline(TypedMooseResource, Generic[T]):
             stream_config.destination = self.table
             if config.version:
                 stream_config.version = config.version
+            stream_config.metadata = stream_metadata
             self.stream = Stream(name, stream_config, t=self._t)
         if config.ingest:
             if self.stream is None:
@@ -549,6 +569,7 @@ class IngestPipeline(TypedMooseResource, Generic[T]):
             ingest_config_dict["destination"] = self.stream
             if config.version:
                 ingest_config_dict["version"] = config.version
+            ingest_config_dict["metadata"] = ingest_metadata
             ingest_config = IngestConfigWithDestination(**ingest_config_dict)
             self.ingest_api = IngestApi(name, ingest_config, t=self._t)
 
@@ -558,8 +579,10 @@ class EgressConfig(BaseModel):
 
     Attributes:
         version: Optional version string.
+        metadata: Optional metadata for the consumption API.
     """
     version: Optional[str] = None
+    metadata: Optional[dict] = None
 
 
 class ConsumptionApi(BaseTypedResource, Generic[T, U]):
@@ -599,17 +622,12 @@ class ConsumptionApi(BaseTypedResource, Generic[T, U]):
 
         return curried_constructor
 
-    def __init__(
-            self,
-            name: str,
-            query_function: Callable[..., U],
-            config: EgressConfig = EgressConfig(),
-            **kwargs
-    ):
+    def __init__(self, name: str, query_function: Callable[..., U], config: EgressConfig = EgressConfig(), **kwargs):
         super().__init__()
         self._set_type(name, self._get_type(kwargs))
         self.config = config
         self.query_function = query_function
+        self.metadata = config.metadata
         _egress_apis[name] = self
 
     @classmethod
@@ -680,13 +698,15 @@ class SqlResource:
         setup: list[str],
         teardown: list[str],
         pulls_data_from: Optional[list[Union[OlapTable, "SqlResource"]]] = None,
-        pushes_data_to: Optional[list[Union[OlapTable, "SqlResource"]]] = None
+        pushes_data_to: Optional[list[Union[OlapTable, "SqlResource"]]] = None,
+        metadata: dict = None
     ):
         self.name = name
         self.setup = setup
         self.teardown = teardown
         self.pulls_data_from = pulls_data_from or []
         self.pushes_data_to = pushes_data_to or []
+        self.metadata = metadata
         _sql_resources[name] = self
 
 
@@ -700,12 +720,12 @@ class View(SqlResource):
                      that this view depends on.
     """
 
-    def __init__(self, name: str, select_statement: str, base_tables: list[Union[OlapTable, SqlResource]]):
+    def __init__(self, name: str, select_statement: str, base_tables: list[Union[OlapTable, SqlResource]], metadata: dict = None):
         setup = [
             f"CREATE VIEW IF NOT EXISTS {name} AS {select_statement}".strip()
         ]
         teardown = [f"DROP VIEW IF EXISTS {name}"]
-        super().__init__(name, setup, teardown, pulls_data_from=base_tables)
+        super().__init__(name, setup, teardown, pulls_data_from=base_tables, metadata=metadata)
 
 
 class MaterializedViewOptions(BaseModel):
@@ -758,6 +778,7 @@ class MaterializedView(SqlResource, BaseTypedResource, Generic[T]):
     def __init__(
             self,
             options: MaterializedViewOptions,
+            metadata: dict = None,
             **kwargs
     ):
         self._set_type(options.materialized_view_name, self._get_type(kwargs))
@@ -782,7 +803,8 @@ class MaterializedView(SqlResource, BaseTypedResource, Generic[T]):
             setup,
             teardown,
             pulls_data_from=options.select_tables,
-            pushes_data_to=[target_table]
+            pushes_data_to=[target_table],
+            metadata=metadata
         )
 
         self.target_table = target_table

moose_lib/internal.py

@@ -28,10 +28,12 @@ class Target(BaseModel):
         kind: The type of the target (currently only "stream").
         name: The name of the target stream.
         version: Optional version of the target stream configuration.
+        metadata: Optional metadata for the target stream.
     """
     kind: Literal["stream"]
     name: str
     version: Optional[str] = None
+    metadata: Optional[dict] = None
 
 class Consumer(BaseModel):
     """Represents a consumer attached to a stream.
@@ -51,6 +53,7 @@ class TableConfig(BaseModel):
         deduplicate: Whether the table uses a deduplicating engine (e.g., ReplacingMergeTree).
         engine: The name of the ClickHouse engine used.
         version: Optional version string of the table configuration.
+        metadata: Optional metadata for the table.
     """
     model_config = model_config
 
@@ -60,6 +63,7 @@ class TableConfig(BaseModel):
     deduplicate: bool
     engine: Optional[str]
     version: Optional[str] = None
+    metadata: Optional[dict] = None
 
 class TopicConfig(BaseModel):
     """Internal representation of a stream/topic configuration for serialization.
@@ -75,6 +79,7 @@ class TopicConfig(BaseModel):
         transformation_targets: List of streams this topic transforms data into.
         has_multi_transform: Flag indicating if a multi-transform function is defined.
         consumers: List of consumers attached to this topic.
+        metadata: Optional metadata for the topic.
     """
     model_config = model_config
 
@@ -88,6 +93,7 @@ class TopicConfig(BaseModel):
     transformation_targets: List[Target]
     has_multi_transform: bool
     consumers: List[Consumer]
+    metadata: Optional[dict] = None
 
 class IngestApiConfig(BaseModel):
     """Internal representation of an Ingest API configuration for serialization.
@@ -97,6 +103,7 @@ class IngestApiConfig(BaseModel):
         columns: List of columns expected in the input data.
         write_to: The target stream where the ingested data is written.
         version: Optional version string of the API configuration.
+        metadata: Optional metadata for the API.
     """
     model_config = model_config
 
@@ -104,6 +111,7 @@ class IngestApiConfig(BaseModel):
     columns: List[Column]
     write_to: Target
     version: Optional[str] = None
+    metadata: Optional[dict] = None
 
 class EgressApiConfig(BaseModel):
     """Internal representation of a Consumption (Egress) API configuration for serialization.
@@ -113,6 +121,7 @@ class EgressApiConfig(BaseModel):
         query_params: List of columns representing the expected query parameters.
         response_schema: JSON schema definition of the API's response body.
         version: Optional version string of the API configuration.
+        metadata: Optional metadata for the API.
     """
     model_config = model_config
 
@@ -120,6 +129,7 @@ class EgressApiConfig(BaseModel):
     query_params: List[Column]
     response_schema: JsonSchemaValue
     version: Optional[str] = None
+    metadata: Optional[dict] = None
 
 class InfrastructureSignatureJson(BaseModel):
     """Represents the unique signature of an infrastructure component (Table, Topic, etc.).
@@ -142,6 +152,7 @@ class SqlResourceConfig(BaseModel):
         teardown: List of SQL commands required to drop the resource.
         pulls_data_from: List of infrastructure components this resource reads from.
         pushes_data_to: List of infrastructure components this resource writes to.
+        metadata: Optional metadata for the resource.
     """
     model_config = model_config
 
@@ -150,6 +161,7 @@ class SqlResourceConfig(BaseModel):
     teardown: list[str]
     pulls_data_from: list[InfrastructureSignatureJson]
     pushes_data_to: list[InfrastructureSignatureJson]
+    metadata: Optional[dict] = None
 
 
 class InfrastructureMap(BaseModel):
@@ -230,12 +242,18 @@ def to_infra_map() -> dict:
             order_by=table.config.order_by_fields,
             deduplicate=table.config.deduplicate,
             engine=None if engine is None else engine.value,
-            version=table.config.version
+            version=table.config.version,
+            metadata=getattr(table, "metadata", None),
         )
 
     for name, stream in _streams.items():
         transformation_targets = [
-            Target(kind="stream", name=dest_name, version=transform.config.version)
+            Target(
+                kind="stream",
+                name=dest_name,
+                version=transform.config.version,
+                metadata=getattr(transform.config, "metadata", None),
+            )
             for dest_name, transforms in stream.transformations.items()
             for transform in transforms
         ]
@@ -255,7 +273,8 @@ def to_infra_map() -> dict:
             version=stream.config.version,
             transformation_targets=transformation_targets,
             has_multi_transform=stream._multipleTransformations is not None,
-            consumers=consumers
+            consumers=consumers,
+            metadata=getattr(stream, "metadata", None),
         )
 
     for name, api in _ingest_apis.items():
@@ -266,7 +285,8 @@ def to_infra_map() -> dict:
             write_to=Target(
                 kind="stream",
                 name=api.config.destination.name
-            )
+            ),
+            metadata=getattr(api, "metadata", None),
         )
 
     for name, api in _egress_apis.items():
@@ -274,7 +294,8 @@ def to_infra_map() -> dict:
             name=name,
             query_params=_to_columns(api.model_type),
             response_schema=api.get_response_schema(),
-            version=api.config.version
+            version=api.config.version,
+            metadata=getattr(api, "metadata", None),
         )
 
     for name, resource in _sql_resources.items():
@@ -283,7 +304,8 @@ def to_infra_map() -> dict:
             setup=resource.setup,
             teardown=resource.teardown,
             pulls_data_from=[_map_sql_resource_ref(dep) for dep in resource.pulls_data_from],
-            pushes_data_to=[_map_sql_resource_ref(dep) for dep in resource.pushes_data_to]
+            pushes_data_to=[_map_sql_resource_ref(dep) for dep in resource.pushes_data_to],
+            metadata=getattr(resource, "metadata", None),
         )
 
     infra_map = InfrastructureMap(

{moose_lib-0.4.162.dist-info → moose_lib-0.4.164.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: moose_lib
-Version: 0.4.162
+Version: 0.4.164
 Home-page: https://www.fiveonefour.com/moose
 Author: Fiveonefour Labs Inc.
 Author-email: support@fiveonefour.com

{moose_lib-0.4.162.dist-info → moose_lib-0.4.164.dist-info}/RECORD

@@ -3,8 +3,8 @@ moose_lib/blocks.py,sha256=_wdvC2NC_Y3MMEnB71WTgWbeQ--zPNHk19xjToJW0C0,3185
 moose_lib/commons.py,sha256=BV5X78MuOWHiZV9bsWSN69JIvzTNWUi-gnuMiAtaO8A,2489
 moose_lib/data_models.py,sha256=1U8IFQaO1hR8pNGb1UTtdcGQehGgKIvLNtUFFFXC1Ko,7695
 moose_lib/dmv2-serializer.py,sha256=CL_Pvvg8tJOT8Qk6hywDNzY8MYGhMVdTOw8arZi3jng,49
-moose_lib/dmv2.py,sha256=ahkOdAhEfi7-UN-UHOxFoAZRupO_-6zG7DfxUq9o60c,30530
-moose_lib/internal.py,sha256=URimCqQUW2aUnTmhsXWW2IHt6Gy_xuDih5fVH8SPHDI,12159
+moose_lib/dmv2.py,sha256=f3VsBYcTcWU1rEUjqG9cHcZxRUlXP_yBTbyoc7Tp7oI,31754
+moose_lib/internal.py,sha256=gREvC3XxBFN4i7JL5uMj0riCu_JUO2YyiMZvCokg1ME,13101
 moose_lib/main.py,sha256=In-u7yA1FsLDeP_2bhIgBtHY_BkXaZqDwf7BxwyC21c,8471
 moose_lib/query_param.py,sha256=AB5BKu610Ji-h1iYGMBZKfnEFqt85rS94kzhDwhWJnc,6288
 moose_lib/tasks.py,sha256=6MXA0j7nhvQILAJVTQHCAsquwrSOi2zAevghAc_7kXs,1554
@@ -13,7 +13,7 @@ moose_lib/streaming/streaming_function_runner.py,sha256=K53lyzGLawAgKgrK3jreJrB7
 tests/__init__.py,sha256=0Gh4yzPkkC3TzBGKhenpMIxJcRhyrrCfxLSfpTZnPMQ,53
 tests/conftest.py,sha256=ZVJNbnr4DwbcqkTmePW6U01zAzE6QD0kNAEZjPG1f4s,169
 tests/test_moose.py,sha256=mBsx_OYWmL8ppDzL_7Bd7xR6qf_i3-pCIO3wm2iQNaA,2136
-moose_lib-0.4.162.dist-info/METADATA,sha256=xj7rnL729QJ5jhzALdA-zgyaiTroQudch37PwFTGfXA,575
-moose_lib-0.4.162.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-moose_lib-0.4.162.dist-info/top_level.txt,sha256=XEns2-4aCmGp2XjJAeEH9TAUcGONLnSLy6ycT9FSJh8,16
-moose_lib-0.4.162.dist-info/RECORD,,
+moose_lib-0.4.164.dist-info/METADATA,sha256=kc5TOymVYCETNBq1SQ4H4vTVyOkmRLOhhs7KBVjsYA4,575
+moose_lib-0.4.164.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+moose_lib-0.4.164.dist-info/top_level.txt,sha256=XEns2-4aCmGp2XjJAeEH9TAUcGONLnSLy6ycT9FSJh8,16
+moose_lib-0.4.164.dist-info/RECORD,,