[6/n][dagster-powerbi] publish dagster-powerbi, add apidoc

dagster-io · Aug 7, 2024 · 4ea19c8 · 4ea19c8
1 parent afa86ae
commit 4ea19c8
Show file tree

Hide file tree

Showing 15 changed files with 48 additions and 9 deletions.
diff --git a/docs/content/_apidocs.mdx b/docs/content/_apidocs.mdx
@@ -610,6 +610,16 @@ Dagster also provides a growing set of optional add-on libraries to integrate wi
         Includes implementations of run and event log storage built on Postgres.
       </td>
     </tr>
+    <tr>
+      <td>
+        <a href="/_apidocs/libraries/dagster-powerbi">Power BI</a> (
+        <code>dagster-powerbi</code>)
+      </td>
+      <td>
+        Provides an integration to represent a Power BI workspace as a graph of
+        assets.
+      </td>
+    </tr>
     <tr>
       <td>
         <a href="/_apidocs/libraries/dagster-prometheus">Prometheus</a> (

diff --git a/docs/content/_navigation.json b/docs/content/_navigation.json
@@ -1501,6 +1501,10 @@
             "title": "PostgreSQL (dagster-postgres)",
             "path": "/_apidocs/libraries/dagster-postgres"
           },
+          {
+            "title": "Power BI (dagster-powerbi)",
+            "path": "/_apidocs/libraries/dagster-powerbi"
+          },
           {
             "title": "Prometheus (dagster-prometheus)",
             "path": "/_apidocs/libraries/dagster-prometheus"

diff --git a/docs/content/api/modules.json.gz b/docs/content/api/modules.json.gz
diff --git a/docs/content/api/searchindex.json.gz b/docs/content/api/searchindex.json.gz
diff --git a/docs/content/api/sections.json.gz b/docs/content/api/sections.json.gz
diff --git a/docs/next/public/objects.inv b/docs/next/public/objects.inv
diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py
@@ -38,6 +38,7 @@
     "../../python_modules/libraries/dagster-github",
     "../../python_modules/libraries/dagster-k8s",
     "../../python_modules/libraries/dagster-looker",
+    "../../python_modules/libraries/dagster-powerbi",
     "../../python_modules/libraries/dagster-managed-elements",
     "../../python_modules/libraries/dagster-mlflow",
     "../../python_modules/libraries/dagster-msteams",

diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst
@@ -67,6 +67,7 @@
    sections/api/apidocs/libraries/dagster-pipes
    sections/api/apidocs/libraries/dagster-polars
    sections/api/apidocs/libraries/dagster-postgres
+   sections/api/apidocs/libraries/dagster-powerbi
    sections/api/apidocs/libraries/dagster-prometheus
    sections/api/apidocs/libraries/dagster-pyspark
    sections/api/apidocs/libraries/dagster-shell

diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagster-powerbi.rst b/docs/sphinx/sections/api/apidocs/libraries/dagster-powerbi.rst
@@ -0,0 +1,17 @@
+##########################
+Power BI (dagster-powerbi)
+##########################
+
+Dagster allows you to represent your Power BI workspace as assets, alongside other your other
+technologies like dbt and Sling. This allows you to see how your Power BI assets are connected to
+your other data assets, and how changes to other data assets might impact your Power BI project.
+
+.. currentmodule:: dagster_powerbi
+
+
+Assets
+======
+
+.. autoclass:: DagsterPowerBITranslator
+
+.. autoclass:: PowerBIWorkspace
diff --git a/docs/tox.ini b/docs/tox.ini
@@ -45,6 +45,7 @@ deps =
   -e ../python_modules/libraries/dagster-deltalake-polars
   -e ../python_modules/libraries/dagster-openai
   -e ../python_modules/libraries/dagster-looker
+  -e ../python_modules/libraries/dagster-powerbi
 
 commands =
   make --directory=sphinx clean

diff --git a/python_modules/libraries/dagster-powerbi/dagster_powerbi/__init__.py b/python_modules/libraries/dagster-powerbi/dagster_powerbi/__init__.py
@@ -2,8 +2,6 @@
 
 from .resource import PowerBIWorkspace as PowerBIWorkspace
 from .translator import DagsterPowerBITranslator as DagsterPowerBITranslator
-
-# Move back to version.py and edit setup.py once we are ready to publish.
-__version__ = "1!0+dev"
+from .version import __version__
 
 DagsterLibraryRegistry.register("dagster-powerbi", __version__)
diff --git a/python_modules/libraries/dagster-powerbi/dagster_powerbi/resource.py b/python_modules/libraries/dagster-powerbi/dagster_powerbi/resource.py
@@ -2,6 +2,7 @@
 
 import requests
 from dagster import ConfigurableResource
+from dagster._annotations import public
 from dagster._core.definitions.asset_spec import AssetSpec
 from dagster._core.definitions.cacheable_assets import extract_from_current_repository_load_data
 from dagster._utils.cached_method import cached_method
@@ -18,6 +19,7 @@
 BASE_API_URL = "https://api.powerbi.com/v1.0/myorg/"
 
 
+@public
 class PowerBIWorkspace(ConfigurableResource):
     """Represents a workspace in PowerBI and provides utilities
     to interact with the PowerBI API.
@@ -119,6 +121,7 @@ def fetch_powerbi_workspace_data(
             dashboards + reports + semantic_models + list(data_sources_by_id.values()),
         )
 
+    @public
     def build_asset_specs(
         self,
         dagster_powerbi_translator: Type[DagsterPowerBITranslator] = DagsterPowerBITranslator,

diff --git a/python_modules/libraries/dagster-powerbi/dagster_powerbi/translator.py b/python_modules/libraries/dagster-powerbi/dagster_powerbi/translator.py
@@ -4,6 +4,7 @@
 from typing import Any, Dict, Generic, Mapping, Sequence
 
 from dagster import _check as check
+from dagster._annotations import public
 from dagster._core.definitions.asset_key import AssetKey
 from dagster._core.definitions.asset_spec import AssetSpec
 from dagster._core.definitions.cacheable_assets import (
@@ -115,6 +116,7 @@ def from_content_data(
         )
 
 
+@public
 class DagsterPowerBITranslator(DagsterTranslator[PowerBIContentData, PowerBIWorkspaceData]):
     """Translator class which converts raw response data from the PowerBI API into AssetSpecs.
     Subclass this class to implement custom logic for each type of PowerBI content.

diff --git a/python_modules/libraries/dagster-powerbi/dagster_powerbi/version.py b/python_modules/libraries/dagster-powerbi/dagster_powerbi/version.py
@@ -0,0 +1 @@
+__version__ = "1!0+dev"
diff --git a/python_modules/libraries/dagster-powerbi/setup.py b/python_modules/libraries/dagster-powerbi/setup.py
@@ -1,14 +1,15 @@
+from pathlib import Path
+from typing import Dict
+
 from setuptools import find_packages, setup
 
 
 def get_version() -> str:
-    return "1!0+dev"
-    # Uncomment when ready to publish
-    # version: Dict[str, str] = {}
-    # with open(Path(__file__).parent / "dagster_powerbi/version.py", encoding="utf8") as fp:
-    #     exec(fp.read(), version)
+    version: Dict[str, str] = {}
+    with open(Path(__file__).parent / "dagster_powerbi/version.py", encoding="utf8") as fp:
+        exec(fp.read(), version)
 
-    # return version["__version__"]
+    return version["__version__"]
 
 
 ver = get_version()