dbdocs 1.5.0__tar.gz → 1.6.0__tar.gz

{dbdocs-1.5.0 → dbdocs-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbdocs
-Version: 1.5.0
+Version: 1.6.0
 Summary: Alternative dbt docs site: Catalog + ERD + column-level lineage
 Project-URL: Homepage, https://github.com/datnguye/dbt-docs
 Project-URL: Repository, https://github.com/datnguye/dbt-docs
@@ -56,6 +56,7 @@ dbt's built-in docs stop short of telling you *which upstream column fed this do
 - **Project Health Check** across the six [dbt-project-evaluator](https://dbt-labs.github.io/dbt-project-evaluator/) dimensions.
 - **Versioned deploys** with a built-in version switcher, no plugins.
 - **Full-text search** across names, columns, descriptions, tags, and SQL at the client-side, no backend.
+- **Static REST API** (`api/v1/`) — addressable JSON for every node, lineage, and health, for headless / agent consumption.
 - **Dark / light theme.**
 
 ## Install

{dbdocs-1.5.0 → dbdocs-1.6.0}/README.md

@@ -32,6 +32,7 @@ dbt's built-in docs stop short of telling you *which upstream column fed this do
 - **Project Health Check** across the six [dbt-project-evaluator](https://dbt-labs.github.io/dbt-project-evaluator/) dimensions.
 - **Versioned deploys** with a built-in version switcher, no plugins.
 - **Full-text search** across names, columns, descriptions, tags, and SQL at the client-side, no backend.
+- **Static REST API** (`api/v1/`) — addressable JSON for every node, lineage, and health, for headless / agent consumption.
 - **Dark / light theme.**
 
 ## Install

{dbdocs-1.5.0 → dbdocs-1.6.0}/dbdocs/core/artifacts.py

@@ -25,6 +25,18 @@ UNKNOWN = "_unknown"
 #: unique_id prefixes surfaced as catalog nodes (tests/macros/etc. excluded).
 NODE_PREFIXES = ("model.", "seed.", "snapshot.")
 
+#: unique_id prefixes for manifest.nodes entries that carry only code (no columns).
+CODE_ONLY_PREFIXES = ("analysis.", "operation.")
+
+#: Manifest collections outside manifest.nodes, mapping id_prefix → attribute name.
+COLLECTION_ATTRS: "dict[str, str]" = {
+    "metric.": "metrics",
+    "semantic_model.": "semantic_models",
+    "saved_query.": "saved_queries",
+    "unit_test.": "unit_tests",
+    "exposure.": "exposures",
+}
+
 
 def artifact_version(target_path: str, artifact: str) -> "int | None":
     """Resolve a dbt artifact's schema version int from its ``dbt_schema_version``.

{dbdocs-1.5.0 → dbdocs-1.6.0}/dbdocs/core/config.py

@@ -81,6 +81,11 @@ class DbDocsConfig:
     #: dotted import path whose ``register_rule`` calls add custom rules). Entry
     #: points under ``dbdocs.health_rules`` are also discovered automatically.
     health: dict = field(default_factory=dict)
+    #: The pinned About link shows by default; set false to hide it.
+    show_about: bool = True
+    #: Links rendered on the About page as external CTA buttons.  Each entry is a
+    #: ``{label, href}`` dict; empty by default — no extra links.
+    about_links: list = field(default_factory=list)
 
     @classmethod
     def load(cls, path: "str | Path | None" = None) -> "DbDocsConfig":

{dbdocs-1.5.0 → dbdocs-1.6.0}/dbdocs/extract/graph.py

@@ -2,14 +2,18 @@
 
 ``LineageGraph`` turns the manifest's ``parent_map`` (falling back to per-node
 ``depends_on.nodes``) into directed parent→child edges plus adjacency maps,
-restricted to the nodes the SPA actually surfaces (models/seeds/snapshots/
-sources) so test/macro dependencies don't dangle. The result feeds the
-interactive DAG view.
+covering all surfaced resource types (models/seeds/snapshots/sources/analyses/
+operations/metrics/semantic_models/saved_queries/unit_tests/exposures) so that
+``dependsOn``/``referencedBy`` on new pages resolve correctly.
+
+The visual DAG view filters by ``data-rtype`` in the graph bundle, so including
+non-physical types in the lineage graph does not pollute the DAG display. Macros
+and test nodes are still excluded — they are never surfaced as navigable pages.
 """
 
 from typing import Any
 
-from dbdocs.core.artifacts import NODE_PREFIXES
+from dbdocs.core.artifacts import CODE_ONLY_PREFIXES, COLLECTION_ATTRS, NODE_PREFIXES
 
 
 class LineageGraph:
@@ -17,17 +21,17 @@ class LineageGraph:
 
     def __init__(self, manifest: Any, node_ids: "set | None" = None) -> None:
         self.manifest = manifest
-        #: Restrict edges to these ids. Defaults to models/seeds/snapshots +
-        #: sources derived from the manifest, matching ``nodes.build_nodes``.
         self.node_ids = node_ids if node_ids is not None else self._default_node_ids()
 
     def _default_node_ids(self) -> set:
         ids = {
             uid
             for uid in (getattr(self.manifest, "nodes", {}) or {})
-            if str(uid).startswith(NODE_PREFIXES)
+            if str(uid).startswith(NODE_PREFIXES + CODE_ONLY_PREFIXES)
         }
         ids.update(getattr(self.manifest, "sources", {}) or {})
+        for attr in COLLECTION_ATTRS.values():
+            ids.update(getattr(self.manifest, attr, None) or {})
         return ids
 
     def build(self) -> dict:
@@ -69,4 +73,7 @@ class LineageGraph:
     def _lookup(self, unique_id: str) -> Any:
         if str(unique_id).startswith("source."):
             return (getattr(self.manifest, "sources", {}) or {}).get(unique_id)
+        for prefix, attr in COLLECTION_ATTRS.items():
+            if str(unique_id).startswith(prefix):
+                return (getattr(self.manifest, attr, None) or {}).get(unique_id)
         return (getattr(self.manifest, "nodes", {}) or {}).get(unique_id)

{dbdocs-1.5.0 → dbdocs-1.6.0}/dbdocs/extract/health/extractor.py

@@ -34,6 +34,7 @@ from pydantic import ValidationError
 
 from dbdocs.core.log import logger
 from dbdocs.extract.health.dimensions import DimensionAnalyzer
+from dbdocs.extract.tests_index import manifest_test_node_details, manifest_test_node_metadata
 
 # ---------------------------------------------------------------------------
 # Test type → category mapping
@@ -108,13 +109,21 @@ def _is_unit_test(unique_id: str) -> bool:
     return unique_id.startswith(_UNIT_TEST_PREFIX)
 
 
+#: Adapter-emitted aliases for a successful test result, normalized to ``"pass"``
+#: so the status pills / per-test badges tally correctly. Snowflake and a few
+#: other adapters emit ``"success"`` for an asserting test that returned 0 rows.
+_PASS_ALIASES = {"success", "ok"}
+
+
 def _status_value(status: Any) -> str:
-    """The plain status string for a result.
+    """The plain status string for a result, with adapter aliases normalized.
 
     artifact-parser models ``status`` as a versioned enum (e.g. ``Status1.pass_``
     with value ``"pass"``); fall back to ``str`` for anything that isn't enum-like.
+    Adapter aliases for success (``"success"``/``"ok"``) collapse to ``"pass"``.
     """
-    return str(getattr(status, "value", status) or "unknown")
+    raw = str(getattr(status, "value", status) or "unknown").lower()
+    return "pass" if raw in _PASS_ALIASES else raw
 
 
 def _short_name(unique_id: str) -> str:
@@ -204,9 +213,12 @@ class HealthCheckExtractor:
         is_unit = _is_unit_test(uid)
         if is_unit:
             test_type, model, column, category = "unit_test", self._unit_test_model(uid), "", "unit"
+            description, kwargs = "", {}
         else:
-            test_type, model, column = self._resolve_metadata(uid)
+            node = self._nodes.get(uid)
+            test_type, model, column = self._resolve_metadata(node, uid)
             category = TEST_CATEGORIES.get(test_type, _FALLBACK_CATEGORY)
+            description, kwargs = self._resolve_details(node)
         return {
             "rule": _short_name(uid),
             "kind": "unit" if is_unit else "data",
@@ -216,24 +228,27 @@ class HealthCheckExtractor:
             "status": _status_value(getattr(result, "status", "unknown")),
             "failures": int(getattr(result, "failures", 0) or 0),
             "message": str(getattr(result, "message", "") or ""),
+            "description": description,
+            "kwargs": kwargs,
             "category": category,
             "docs_url": _UNIT_TESTS_DOCS if is_unit else _TESTS_DOCS,
         }
 
-    def _resolve_metadata(self, unique_id: str) -> "tuple[str, str, str]":
+    @staticmethod
+    def _resolve_details(node: Any) -> "tuple[str, dict]":
+        """Manifest description + kwargs for a data-test node, or ``("", {})``."""
+        return manifest_test_node_details(node) if node is not None else ("", {})
+
+    def _resolve_metadata(self, node: Any, unique_id: str) -> "tuple[str, str, str]":
         """``(test_type, model, column)`` for a *data* test, manifest-first.
 
         Reads the authoritative test type / tested model / column from the
         manifest node when available; falls back to inferring the type from the
         ``unique_id`` (model/column then unknown) when it isn't.
         """
-        node = self._nodes.get(unique_id)
         if node is not None:
-            metadata = getattr(node, "test_metadata", None)
-            test_type = str(getattr(metadata, "name", "") or "") if metadata else ""
-            model = _short_name(str(getattr(node, "attached_node", "") or ""))
-            column = str(getattr(node, "column_name", "") or "")
-            return test_type, model, column
+            test_type, attached, column = manifest_test_node_metadata(node)
+            return test_type, _short_name(attached), column
         return _infer_test_type(unique_id), "", ""
 
     def _unit_test_model(self, unique_id: str) -> str: