dagster-omni 0.27.16__py3-none-any.whl → 0.28.0__py3-none-any.whl

dagster_omni/component.py

@@ -4,7 +4,7 @@ from pathlib import Path
 from typing import Optional
 
 import dagster as dg
-from dagster._annotations import preview
+from dagster._annotations import preview, public
 from dagster._core.errors import DagsterInvalidDefinitionError
 from dagster.components.component.state_backed_component import StateBackedComponent
 from dagster.components.utils.defs_state import (
@@ -26,6 +26,21 @@ from dagster_omni.workspace import OmniWorkspace
 
 @preview
 class OmniComponent(StateBackedComponent, dg.Model, dg.Resolvable):
+    """Pulls in the contents of an Omni workspace into Dagster assets.
+
+    Example:
+
+        .. code-block:: yaml
+
+            # defs.yaml
+
+            type: dagster_omni.OmniComponent
+            attributes:
+              workspace:
+                base_url: https://your-company.omniapp.co
+                api_key: "{{ env.OMNI_API_KEY }}"
+    """
+
     workspace: OmniWorkspace = Field(
         description="Defines configuration for interacting with an Omni instance.",
     )
@@ -81,10 +96,45 @@ class OmniComponent(StateBackedComponent, dg.Model, dg.Resolvable):
             return dg.AssetSpec(key=dg.AssetKey([data.obj.query_config.table]))
         return None
 
+    @public
     def get_asset_spec(
         self, context: dg.ComponentLoadContext, data: OmniTranslatorData
     ) -> Optional[dg.AssetSpec]:
-        """Core function for converting an Omni document into an AssetSpec object."""
+        """Generates an AssetSpec for a given Omni document.
+
+        This method can be overridden in a subclass to customize how Omni documents
+        (workbooks, queries) are converted to Dagster asset specs. By default, it applies
+        any configured translation function to the base asset spec.
+
+        Args:
+            context: The component load context provided by Dagster
+            data: The OmniTranslatorData containing information about the Omni document
+
+        Returns:
+            An AssetSpec that represents the Omni document as a Dagster asset, or None
+            if the document should not be represented as an asset
+
+        Example:
+            Override this method to add custom metadata based on document properties:
+
+            .. code-block:: python
+
+                from dagster_omni import OmniComponent
+                import dagster as dg
+
+                class CustomOmniComponent(OmniComponent):
+                    def get_asset_spec(self, context, data):
+                        base_spec = super().get_asset_spec(context, data)
+                        if base_spec:
+                            return base_spec.replace_attributes(
+                                metadata={
+                                    **base_spec.metadata,
+                                    "omni_type": type(data.obj).__name__,
+                                    "workspace": data.workspace_data.workspace_id
+                                }
+                            )
+                        return None
+        """
         base_asset_spec = self._get_default_omni_spec(context, data, self.workspace)
         if self.translation and base_asset_spec:
             return self.translation(base_asset_spec, data)

dagster_omni/version.py

@@ -1 +1 @@
-__version__ = "0.27.16"
+__version__ = "0.28.0"

{dagster_omni-0.27.16.dist-info → dagster_omni-0.28.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dagster_omni
-Version: 0.27.16
+Version: 0.28.0
 Summary: Package for integrating Omni with Dagster.
 Home-page: https://github.com/dagster-io/dagster/tree/master/python_modules/libraries/dagster-omni
 Author: Dagster Labs
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 License-File: LICENSE
-Requires-Dist: dagster==1.11.16
+Requires-Dist: dagster==1.12.0
 Requires-Dist: aiohttp
 Requires-Dist: python-dateutil
 Dynamic: author

dagster_omni-0.28.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+dagster_omni/__init__.py,sha256=6QUEBSqA3cRAb4kSWqkdvkUiKMbk0NY1YFdJPW0JEkQ,249
+dagster_omni/component.py,sha256=47CRd2190icq6MAynZzXU6893R5EjPmwMfED4W-tk90,7555
+dagster_omni/objects.py,sha256=4cknF4xIljTYYWYCOKe8Tkaled0_Gq9u9g8Ze_mYnyQ,4960
+dagster_omni/py.typed,sha256=mDShSrm8qg9qjacQc2F-rI8ATllqP6EdgHuEYxuCXZ0,7
+dagster_omni/translation.py,sha256=ExEc_WU7qbnJ5fpWUdK_TSGRJQ-a2H13apqwM1LvdaY,4820
+dagster_omni/version.py,sha256=MRQGtOXBhcDKeeNOL0LiB-cllo6kfd8_KGJOvaDp0XQ,23
+dagster_omni/workspace.py,sha256=C2fjZIw64TEKWRtpzt6rRm5MSY4RKCXJW22ANJBjY-o,5893
+dagster_omni-0.28.0.dist-info/licenses/LICENSE,sha256=lY5yc1KHX4HoXjlWnIPGcCAsnNney2rb8M8ccT6NzRQ,11347
+dagster_omni-0.28.0.dist-info/METADATA,sha256=MeG36hofIU6llozLUL9uMTqxGIAazeu1khqNz2kQMO0,912
+dagster_omni-0.28.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+dagster_omni-0.28.0.dist-info/top_level.txt,sha256=FJO_1xyIWRN_nGhCDQPirG5NrEsB-wPR7eY5puEgJes,13
+dagster_omni-0.28.0.dist-info/RECORD,,

dagster_omni-0.27.16.dist-info/RECORD

@@ -1,12 +0,0 @@
-dagster_omni/__init__.py,sha256=6QUEBSqA3cRAb4kSWqkdvkUiKMbk0NY1YFdJPW0JEkQ,249
-dagster_omni/component.py,sha256=DMyfsfywAfa4CI8trBRGdpIUxVgTvHbK5P00v5cn9HE,5724
-dagster_omni/objects.py,sha256=4cknF4xIljTYYWYCOKe8Tkaled0_Gq9u9g8Ze_mYnyQ,4960
-dagster_omni/py.typed,sha256=mDShSrm8qg9qjacQc2F-rI8ATllqP6EdgHuEYxuCXZ0,7
-dagster_omni/translation.py,sha256=ExEc_WU7qbnJ5fpWUdK_TSGRJQ-a2H13apqwM1LvdaY,4820
-dagster_omni/version.py,sha256=gNIskoVbgqFeY6KiyOzkhfP7GLwnNVmVeil7tBvkL44,24
-dagster_omni/workspace.py,sha256=C2fjZIw64TEKWRtpzt6rRm5MSY4RKCXJW22ANJBjY-o,5893
-dagster_omni-0.27.16.dist-info/licenses/LICENSE,sha256=lY5yc1KHX4HoXjlWnIPGcCAsnNney2rb8M8ccT6NzRQ,11347
-dagster_omni-0.27.16.dist-info/METADATA,sha256=j1IFP2tkc7pbSdd2e2sJyRlkKNtyL9fysJvK2TFdn-w,914
-dagster_omni-0.27.16.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-dagster_omni-0.27.16.dist-info/top_level.txt,sha256=FJO_1xyIWRN_nGhCDQPirG5NrEsB-wPR7eY5puEgJes,13
-dagster_omni-0.27.16.dist-info/RECORD,,