dagster-evidence 0.1.4__tar.gz → 0.1.6__tar.gz

{dagster_evidence-0.1.4 → dagster_evidence-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dagster-evidence
-Version: 0.1.4
+Version: 0.1.6
 Summary: Dagster integration with evidence.dev
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown

dagster_evidence-0.1.6/dagster_evidence/__init__.py

@@ -0,0 +1,12 @@
+from dagster._core.libraries import DagsterLibraryRegistry
+
+from dagster_evidence.lib.evidence_project import EvidenceProject
+from dagster_evidence.resource import EvidenceResource
+
+__version__ = "0.1.6"
+
+__all__ = [EvidenceProject, EvidenceResource]
+
+DagsterLibraryRegistry.register(
+    "dagster-evidence", __version__, is_dagster_package=False
+)

dagster_evidence-0.1.6/dagster_evidence/resource.py

@@ -0,0 +1,69 @@
+import os
+import sys
+import subprocess
+from typing import Optional, Sequence
+import dagster as dg
+from pydantic import Field
+
+
+class EvidenceResource(dg.ConfigurableResource):
+    """A Dagster resource for managing Evidence.dev projects.
+
+    This resource provides functionality to build and deploy Evidence.dev dashboards.
+    It assumes that you have already created an Evidence.dev project. Read [the Evidence docs](https://docs.evidence.dev/) for more information.
+
+    Examples:
+        .. code-block:: python
+            import dagster as dg
+            from dagster_evidence import EvidenceResource
+
+            @dg.asset
+            def evidence_application(evidence: EvidenceResource):
+                evidence.build()
+
+            evidence_resource = EvidenceResource(
+                project_path="/path/to/evidence/project",
+                deploy_command="optional-deploy-command",  # eg. `aws s3 cp ...`
+            )
+
+            defs = dg.Definitions(
+                assets=[evidence_application],
+                resources={"evidence": evidence_resource}
+            )
+    """
+
+    project_path: str = Field(..., description="The path to the Evidence.dev project")
+    deploy_command: Optional[str] = Field(
+        None, description="Command to deploy the built assets"
+    )
+    executable: str = Field(
+        default="npm",
+        description="The executable to use for commands (npm, yarn, etc.)",
+    )
+
+    def _run_cmd(self, cmd: Sequence[str]):
+        """Run a command in the project directory.
+
+        Args:
+            cmd: The command to run as a sequence of strings.
+        """
+        print(
+            f"{self.project_path}$ {' '.join(cmd)}",
+            file=sys.stderr,
+        )
+        subprocess.run(
+            cmd,
+            cwd=self.project_path,
+            check=True,
+            capture_output=False,
+            env=os.environ,
+        )
+
+    def build(self) -> None:
+        """Build the Evidence project.
+
+        1. Run all sources to fetch data
+        2. Build the project to generate the dashboard
+        """
+        self._run_cmd([self.executable, "run", "sources"])
+        self._run_cmd([self.executable, "run", "build"])

{dagster_evidence-0.1.4 → dagster_evidence-0.1.6}/dagster_evidence.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dagster-evidence
-Version: 0.1.4
+Version: 0.1.6
 Summary: Dagster integration with evidence.dev
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown

{dagster_evidence-0.1.4 → dagster_evidence-0.1.6}/dagster_evidence.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 README.md
 pyproject.toml
 dagster_evidence/__init__.py
+dagster_evidence/resource.py
 dagster_evidence.egg-info/PKG-INFO
 dagster_evidence.egg-info/SOURCES.txt
 dagster_evidence.egg-info/dependency_links.txt

{dagster_evidence-0.1.4 → dagster_evidence-0.1.6}/dagster_evidence.egg-info/entry_points.txt

@@ -1,2 +1,5 @@
 [dagster_dg.library]
 dagster_evidence = dagster_evidence
+
+[dagster_dg.plugin]
+dagster_evidence = dagster_evidence

{dagster_evidence-0.1.4 → dagster_evidence-0.1.6}/pyproject.toml

@@ -27,3 +27,4 @@ version = {attr = "dagster_evidence.__version__"}
 
 [project.entry-points]
 "dagster_dg.library" = { dagster_evidence = "dagster_evidence"}
+"dagster_dg.plugin" = { dagster_evidence = "dagster_evidence"}

dagster_evidence-0.1.4/dagster_evidence/__init__.py

@@ -1,9 +0,0 @@
-from dagster._core.libraries import DagsterLibraryRegistry
-
-from dagster_evidence.lib.evidence_project import EvidenceProject
-
-__version__ = "0.1.4"
-
-__all__ = [EvidenceProject]
-
-DagsterLibraryRegistry.register("dagster-evidence", __version__)