feat: support findings table

.vscode/launch.json

@@ -44,6 +44,22 @@
             "env": {
                 "SCRIBE_TOKEN": "${env:SCRIBE_DEV_TOKEN}",
             }
+        },
+                {
+            "name": "Test findings dataset",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "scribe_python_client.cli",
+            "console": "internalConsole",
+            "args": [
+                "--api-call",
+                "query-findings",
+                "--query",
+                "{\"columns\": [\"logical_app\", \"finding\"], \"filters\": [], \"orderby\": [], \"row_limit\": 10}",
+            ],
+            "env": {
+                "SCRIBE_TOKEN": "${env:SCRIBE_TOKEN}",
+            }
         }
 
     ]

scribe_python_client/cli.py

@@ -20,6 +20,7 @@ def main():
         "query-policy-results",
         "query-lineage",
         "query-risk",
+        "query-findings",
     ], help="Which API call to execute")
     parser.add_argument("--api-token", required=False, default=os.getenv('SCRIBE_TOKEN'), help="Your API token from ScribeHub integrations page (defaults to SCRIBE_TOKEN environment variable)")
     parser.add_argument("--env", default="prod", choices=["prod", "dev", "test", "ci"], help="Which environment to use")
@@ -82,6 +83,8 @@ def main():
             # logging.info(f"Lineage graph saved to {args.lineage_graph_file}")
     elif args.api_call == "query-risk":
         print(client.query_risk(querystr=args.query))
+    elif args.api_call == "query-findings":
+        print(client.query_findings(querystr=args.query))
 
 if __name__ == "__main__":
     main()

scribe_python_client/client.py

@@ -15,7 +15,8 @@ from .constants import (
     SCRIBE_POLICY_DATASET,
     SCRIBE_TEAM_STAT_DATASET,
     SCRIBE_LINEAGE_DATASET,
-    SCRIBE_RISK_DATASET
+    SCRIBE_RISK_DATASET,
+    SCRIBE_FINDINGS_DATASET
 )
 
 class ScribeClient:
@@ -25,6 +26,7 @@ class ScribeClient:
     scribe_team_stat_dataset = SCRIBE_TEAM_STAT_DATASET
     scribe_lineage_dataset=SCRIBE_LINEAGE_DATASET
     scribe_risk_dataset = SCRIBE_RISK_DATASET
+    scribe_findings_dataset = SCRIBE_FINDINGS_DATASET
 
     def get_chache_data(self):
         return {
@@ -1067,11 +1069,20 @@ class ScribeClient:
                 return f"{title}\n{self.format_query_result_table(r)}"
         return "Error running query"
     
-    def query_risk(self, querystr, title="", graph_filename=None) -> str:
+    def query_risk(self, querystr, title="") -> str:
         logging.debug(f"Query risk table with: {querystr}")
         query = self.querystr_to_json(querystr)
         if query:
             r = self.query_superset(self.scribe_risk_dataset, query, time_tokens=["timestamp"])
             if r:
                 return f"{title}\n{self.format_query_result_table(r)}"
+        return "Error running query"
+    
+    def query_findings(self, querystr, title="") -> str:
+        logging.debug(f"Query finding table with: {querystr}")
+        query = self.querystr_to_json(querystr)
+        if query:
+            r = self.query_superset(self.scribe_findings_dataset, query, time_tokens=["timestamp"])
+            if r:
+                return f"{title}\n{self.format_query_result_table(r)}"
         return "Error running query"

scribe_python_client/constants.py

@@ -3,4 +3,5 @@ SCRIBE_PRODUCTS_DATASET = "asbom_filtered"
 SCRIBE_POLICY_DATASET = "policy_initiative"
 SCRIBE_TEAM_STAT_DATASET = "MARKETING Team activity"
 SCRIBE_LINEAGE_DATASET = "extended_lineage_new"
-SCRIBE_RISK_DATASET = "product_risk_1.0"
+SCRIBE_RISK_DATASET = "product_risk_1.0"
+SCRIBE_FINDINGS_DATASET = "Findings"