sql-glider 0.1.24__tar.gz → 0.1.26__tar.gz

{sql_glider-0.1.24 → sql_glider-0.1.26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sql-glider
-Version: 0.1.24
+Version: 0.1.26
 Summary: SQL Utility Toolkit for better understanding, use, and governance of your queries in a native environment.
 Project-URL: Homepage, https://github.com/rycowhi/sql-glider/
 Project-URL: Repository, https://github.com/rycowhi/sql-glider/

{sql_glider-0.1.24 → sql_glider-0.1.26}/docs/docs/graph-lineage.md

@@ -258,7 +258,7 @@ sqlglider graph query graph.json --downstream orders.order_total -f dot
 sqlglider graph query graph.json --upstream total_spent -f plotly
 ```
 
-Query diagrams include color-coded nodes and a legend:
+Query diagrams include color-coded nodes, edge labels showing the source SQL file, and a legend:
 
 | Color  | Meaning |
 |--------|---------|
@@ -266,6 +266,8 @@ Query diagrams include color-coded nodes and a legend:
 | Teal   | Root node (no upstream dependencies) |
 | Violet | Leaf node (no downstream consumers) |
 
+Each edge in the diagram is labeled with the SQL filename that defines that relationship, making it easy to trace data flow back to the source code.
+
 **Example:** Imagine a pipeline where a `revenue` report column draws from multiple sources through several transformation layers. Querying `--upstream revenue` would produce a diagram like this:
 
 ```mermaid
@@ -277,12 +279,12 @@ flowchart TD
     staging_orders_tax_amount["staging_orders.tax_amount"]
     mart_orders_total_usd["mart_orders.total_usd"]
     revenue["revenue"]
-    raw_orders_amount --> staging_orders_subtotal
-    raw_orders_tax --> staging_orders_tax_amount
-    staging_orders_subtotal --> mart_orders_total_usd
-    staging_orders_tax_amount --> mart_orders_total_usd
-    raw_exchange_rates_rate --> mart_orders_total_usd
-    mart_orders_total_usd --> revenue
+    raw_orders_amount -->|staging_orders.sql| staging_orders_subtotal
+    raw_orders_tax -->|staging_orders.sql| staging_orders_tax_amount
+    staging_orders_subtotal -->|mart_orders.sql| mart_orders_total_usd
+    staging_orders_tax_amount -->|mart_orders.sql| mart_orders_total_usd
+    raw_exchange_rates_rate -->|mart_orders.sql| mart_orders_total_usd
+    mart_orders_total_usd -->|reports.sql| revenue
 
     style revenue fill:#e6a843,stroke:#b8860b,stroke-width:3px
     style raw_orders_amount fill:#4ecdc4,stroke:#2b9e96
@@ -299,7 +301,7 @@ flowchart TD
     style legend_leaf fill:#c084fc,stroke:#7c3aed
 ```
 
-The amber node is the column you queried (`revenue`), teal nodes are ultimate root sources with no further upstream dependencies (`raw_orders.amount`, `raw_orders.tax`, `raw_exchange_rates.rate`), and intermediate nodes (`staging_orders.*`, `mart_orders.*`) appear in the default style. The legend is included automatically.
+The amber node is the column you queried (`revenue`), teal nodes are ultimate root sources with no further upstream dependencies (`raw_orders.amount`, `raw_orders.tax`, `raw_exchange_rates.rate`), and intermediate nodes (`staging_orders.*`, `mart_orders.*`) appear in the default style. Each edge is labeled with the SQL file that defines that relationship. The legend is included automatically.
 
 ### Mermaid Markdown Format
 
@@ -356,6 +358,10 @@ The Plotly output uses the same color scheme as Mermaid and DOT diagrams:
 | Teal   | Root node (no upstream dependencies) |
 | Violet | Leaf node (no downstream consumers) |
 
+See an example of a plot loaded into Dash below:
+
+![Plotly-Dash Example](./static/plotly-dash-example.png)
+
 ### Rendering Diagrams
 
 **Mermaid:**

{sql_glider-0.1.24 → sql_glider-0.1.26}/examples/plotly_viewer.py

@@ -33,13 +33,19 @@ def load_figure(source: str | Path | None = None) -> dict:
         # Read from stdin
         if sys.stdin.isatty():
             print("Usage: python plotly_viewer.py <lineage.json>", file=sys.stderr)
-            print("   or: sqlglider graph visualize graph.json -f plotly | python plotly_viewer.py", file=sys.stderr)
+            print(
+                "   or: sqlglider graph visualize graph.json -f plotly | python plotly_viewer.py",
+                file=sys.stderr,
+            )
             sys.exit(1)
         content = sys.stdin.read()
         if not content.strip():
             print("Error: No input received from stdin", file=sys.stderr)
             print("Note: On Windows, piping may not work reliably.", file=sys.stderr)
-            print("Try: sqlglider graph query ... -f plotly -o output.json", file=sys.stderr)
+            print(
+                "Try: sqlglider graph query ... -f plotly -o output.json",
+                file=sys.stderr,
+            )
             print("Then: python plotly_viewer.py output.json", file=sys.stderr)
             sys.exit(1)
     else:
@@ -55,7 +61,10 @@ def load_figure(source: str | Path | None = None) -> dict:
             except UnicodeDecodeError:
                 continue
         else:
-            print(f"Error: Could not decode file with UTF-8 or UTF-16 encoding", file=sys.stderr)
+            print(
+                "Error: Could not decode file with UTF-8 or UTF-16 encoding",
+                file=sys.stderr,
+            )
             sys.exit(1)
 
     try: