dagster-evidence 0.1.7__tar.gz → 0.2.0__tar.gz

dagster_evidence-0.2.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: dagster-evidence
+Version: 0.2.0
+Summary: Dagster integration with evidence.dev
+Requires-Python: <3.14,>=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: dagster>=1.12.10
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: github-pages
+Requires-Dist: gitpython>=3.1.0; extra == "github-pages"
+Provides-Extra: sql
+Requires-Dist: sqlglot>=26.0.0; extra == "sql"
+Provides-Extra: duckdb
+Requires-Dist: duckdb>=0.10.0; extra == "duckdb"
+Provides-Extra: bigquery
+Requires-Dist: google-cloud-bigquery>=3.0.0; extra == "bigquery"
+Provides-Extra: gsheets
+Requires-Dist: google-api-python-client>=2.0.0; extra == "gsheets"
+Requires-Dist: google-auth>=2.0.0; extra == "gsheets"
+Provides-Extra: all
+Requires-Dist: gitpython>=3.1.0; extra == "all"
+Requires-Dist: sqlglot>=26.0.0; extra == "all"
+Requires-Dist: duckdb>=0.10.0; extra == "all"
+Requires-Dist: google-cloud-bigquery>=3.0.0; extra == "all"
+Requires-Dist: google-api-python-client>=2.0.0; extra == "all"
+Requires-Dist: google-auth>=2.0.0; extra == "all"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+
+# dagster-evidence
+
+Dagster integration with [Evidence](https://evidence.dev/), enabling you to orchestrate Evidence.dev dashboard projects as Dagster assets.
+
+![architecture](./docs/component-architecture.excalidraw.png)
+## Installation
+
+```bash
+# Basic installation
+uv add dagster-evidence
+
+# With specific data source support
+uv add "dagster-evidence[duckdb]"           # DuckDB support
+uv add "dagster-evidence[bigquery]"         # BigQuery support
+uv add "dagster-evidence[gsheets]"          # Google Sheets support
+uv add "dagster-evidence[github-pages]"     # GitHub Pages deployment
+
+# Install multiple extras
+uv add "dagster-evidence[duckdb,bigquery,github-pages]"
+```
+
+## Features
+
+- **Automatic asset discovery**: Automatically generates Dagster assets from Evidence project sources
+- **Build and deployment**: Builds Evidence projects and deploys them to your hosting platform
+- **Customizable translation**: Extend the translator to customize how Evidence sources map to Dagster assets
+- **Type-safe configuration**: Pydantic-based configuration with YAML support
+- **Source change detection**: Optional sensors to detect changes in upstream data sources
+
+## Supported Data Sources
+
+- DuckDB
+- MotherDuck
+- BigQuery
+- Google Sheets
+
+Need additional source types? You can extend the translator to add custom sources, or contribute to the project!
+
+## Deployment Support
+
+**Currently Implemented:**
+- GitHub Pages: Deploy to GitHub Pages with automatic git push
+- Custom commands: Run any custom deployment script or command
+
+**Need another deployment target?** Open an issue and tag [@milicevica23](https://github.com/milicevica23) with your deployment requirements.
+
+## Quick Start
+
+### Component Configuration (YAML)
+
+```yaml
+# defs.yaml
+type: dagster_evidence.EvidenceProjectComponentV2
+attributes:
+  evidence_project:
+    project_type: local
+    project_path: ./my-evidence-project
+    enable_source_assets_hiding: true
+    enable_source_sensors: false
+    project_deployment:
+      type: github_pages
+      github_repo: my-org/my-dashboard
+      branch: gh-pages
+```
+
+## Advanced Usage
+
+### Custom Translator
+
+You can customize how Evidence sources are translated to Dagster assets:
+
+```python
+from dagster_evidence import DagsterEvidenceTranslator, EvidenceSourceTranslatorData
+import dagster as dg
+
+class MyTranslator(DagsterEvidenceTranslator):
+    def get_asset_spec(self, data):
+        if isinstance(data, EvidenceSourceTranslatorData):
+            # Custom logic for source assets
+            return dg.AssetSpec(
+                key=dg.AssetKey(["custom", data.query.name]),
+                kinds={"evidence", data.source_content.connection.type},
+            )
+        return super().get_asset_spec(data)
+```
+
+
+## Contributing
+
+Contributions are welcome! Please see the main repository's contribution guidelines.

dagster_evidence-0.2.0/README.md

@@ -0,0 +1,90 @@
+# dagster-evidence
+
+Dagster integration with [Evidence](https://evidence.dev/), enabling you to orchestrate Evidence.dev dashboard projects as Dagster assets.
+
+![architecture](./docs/component-architecture.excalidraw.png)
+## Installation
+
+```bash
+# Basic installation
+uv add dagster-evidence
+
+# With specific data source support
+uv add "dagster-evidence[duckdb]"           # DuckDB support
+uv add "dagster-evidence[bigquery]"         # BigQuery support
+uv add "dagster-evidence[gsheets]"          # Google Sheets support
+uv add "dagster-evidence[github-pages]"     # GitHub Pages deployment
+
+# Install multiple extras
+uv add "dagster-evidence[duckdb,bigquery,github-pages]"
+```
+
+## Features
+
+- **Automatic asset discovery**: Automatically generates Dagster assets from Evidence project sources
+- **Build and deployment**: Builds Evidence projects and deploys them to your hosting platform
+- **Customizable translation**: Extend the translator to customize how Evidence sources map to Dagster assets
+- **Type-safe configuration**: Pydantic-based configuration with YAML support
+- **Source change detection**: Optional sensors to detect changes in upstream data sources
+
+## Supported Data Sources
+
+- DuckDB
+- MotherDuck
+- BigQuery
+- Google Sheets
+
+Need additional source types? You can extend the translator to add custom sources, or contribute to the project!
+
+## Deployment Support
+
+**Currently Implemented:**
+- GitHub Pages: Deploy to GitHub Pages with automatic git push
+- Custom commands: Run any custom deployment script or command
+
+**Need another deployment target?** Open an issue and tag [@milicevica23](https://github.com/milicevica23) with your deployment requirements.
+
+## Quick Start
+
+### Component Configuration (YAML)
+
+```yaml
+# defs.yaml
+type: dagster_evidence.EvidenceProjectComponentV2
+attributes:
+  evidence_project:
+    project_type: local
+    project_path: ./my-evidence-project
+    enable_source_assets_hiding: true
+    enable_source_sensors: false
+    project_deployment:
+      type: github_pages
+      github_repo: my-org/my-dashboard
+      branch: gh-pages
+```
+
+## Advanced Usage
+
+### Custom Translator
+
+You can customize how Evidence sources are translated to Dagster assets:
+
+```python
+from dagster_evidence import DagsterEvidenceTranslator, EvidenceSourceTranslatorData
+import dagster as dg
+
+class MyTranslator(DagsterEvidenceTranslator):
+    def get_asset_spec(self, data):
+        if isinstance(data, EvidenceSourceTranslatorData):
+            # Custom logic for source assets
+            return dg.AssetSpec(
+                key=dg.AssetKey(["custom", data.query.name]),
+                kinds={"evidence", data.source_content.connection.type},
+            )
+        return super().get_asset_spec(data)
+```
+
+
+## Contributing
+
+Contributions are welcome! Please see the main repository's contribution guidelines.

dagster_evidence-0.2.0/dagster_evidence/__init__.py

@@ -0,0 +1,29 @@
+from dagster._core.libraries import DagsterLibraryRegistry
+
+from dagster_evidence.components.evidence_project_v2 import EvidenceProjectComponentV2
+from dagster_evidence.components.sources import (
+    EvidenceProjectTranslatorData,
+    EvidenceSourceTranslatorData,
+    ProjectDagsterMetadata,
+    SourceDagsterMetadata,
+)
+from dagster_evidence.components.translator import DagsterEvidenceTranslator
+from dagster_evidence.lib.evidence_project import EvidenceProject
+from dagster_evidence.resource import EvidenceResource
+
+__version__ = "0.2.0"
+
+__all__ = [
+    "EvidenceProjectComponentV2",
+    "EvidenceProject",
+    "EvidenceResource",
+    "DagsterEvidenceTranslator",
+    "EvidenceSourceTranslatorData",
+    "EvidenceProjectTranslatorData",
+    "ProjectDagsterMetadata",
+    "SourceDagsterMetadata",
+]
+
+DagsterLibraryRegistry.register(
+    "dagster-evidence", __version__, is_dagster_package=False
+)

dagster_evidence-0.2.0/dagster_evidence/components/__init__.py

@@ -0,0 +1,17 @@
+from dagster_evidence.components.evidence_project_v2 import (
+    EvidenceProjectComponentV2 as EvidenceProjectComponentV2,
+)
+from dagster_evidence.components.sources import (
+    EvidenceProjectTranslatorData as EvidenceProjectTranslatorData,
+    EvidenceSourceTranslatorData as EvidenceSourceTranslatorData,
+)
+from dagster_evidence.components.translator import (
+    DagsterEvidenceTranslator as DagsterEvidenceTranslator,
+)
+
+__all__ = [
+    "EvidenceProjectComponentV2",
+    "DagsterEvidenceTranslator",
+    "EvidenceSourceTranslatorData",
+    "EvidenceProjectTranslatorData",
+]