adding some extra context to the treeviewer

Author: peter simpson

src/clidat/commands/accounting.py

@@ -31,7 +31,9 @@ def get_accounts(
         order_by=order_by,
     )
     accounts_json = accounts.json()
-    viewer = ViewerDispatcher(data=accounts_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=accounts_json, json_flag=json, data_type="Chart of Accounts"
+    )
     viewer()
 
 
@@ -43,7 +45,9 @@ def get_account(ctx: click.Context, company_id: str, account: str, json: bool =
     client = ctx.obj
     account_result = client.get_account(company_id, account)
     account_result_json = account_result.json()
-    viewer = ViewerDispatcher(data=account_result_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=account_result_json, json_flag=json, data_type="Accounts"
+    )
     viewer()
 
 
@@ -70,7 +74,11 @@ def get_account_transactions(
         order_by=order_by,
     )
     account_transactions_json = account_transactions.json()
-    viewer = ViewerDispatcher(data=account_transactions_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=account_transactions_json,
+        json_flag=json,
+        data_type="List of Account Transactions",
+    )
     viewer()
 
 
@@ -90,7 +98,11 @@ def get_account_transaction(
         company_id, connection, account_transaction
     )
     account_transaction_result_json = account_transaction_result.json()
-    viewer = ViewerDispatcher(data=account_transaction_result_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=account_transaction_result_json,
+        json_flag=json,
+        data_type="Account Transaction",
+    )
     viewer()
 
 
@@ -115,7 +127,9 @@ def get_bills(
         order_by=order_by,
     )
     bills_json = bills.json()
-    viewer = ViewerDispatcher(data=bills_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=bills_json, json_flag=json, data_type="List of Bills"
+    )
     viewer()
 
 
@@ -127,7 +141,7 @@ def get_bill(ctx: click.Context, company_id: str, bill: str, json: bool = False)
     client = ctx.obj
     bill_result = client.get_bill(company_id, bill)
     bill_result_json = bill_result.json()
-    viewer = ViewerDispatcher(data=bill_result_json, json_flag=json)
+    viewer = ViewerDispatcher(data=bill_result_json, json_flag=json, data_type="Bills")
     viewer()
 
 
@@ -152,7 +166,9 @@ def get_suppliers(
         order_by=order_by,
     )
     suppliers_json = suppliers.json()
-    viewer = ViewerDispatcher(data=suppliers_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=suppliers_json, json_flag=json, data_type="List of Suppliers"
+    )
     viewer()
 
 
@@ -166,7 +182,9 @@ def get_supplier(
     client = ctx.obj
     supplier_result = client.get_supplier(company_id, supplier)
     supplier_result_json = supplier_result.json()
-    viewer = ViewerDispatcher(data=supplier_result_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=supplier_result_json, json_flag=json, data_type="Supplier"
+    )
     viewer()
 
 
@@ -191,7 +209,9 @@ def get_invoices(
         order_by=order_by,
     )
     invoices_json = invoices.json()
-    viewer = ViewerDispatcher(data=invoices_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=invoices_json, json_flag=json, data_type="List of Invoices"
+    )
     viewer()
 
 
@@ -203,7 +223,9 @@ def get_invoice(ctx: click.Context, company_id: str, invoice: str, json: bool =
     client = ctx.obj
     invoice_result = client.get_invoice(company_id, invoice)
     invoice_result_json = invoice_result.json()
-    viewer = ViewerDispatcher(data=invoice_result_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=invoice_result_json, json_flag=json, data_type="Invoice"
+    )
     viewer()
 
 
@@ -228,7 +250,9 @@ def get_payments(
         order_by=order_by,
     )
     payments_json = payments.json()
-    viewer = ViewerDispatcher(data=payments_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=payments_json, json_flag=json, data_type="List of Payments"
+    )
     viewer()
 
 
@@ -240,5 +264,7 @@ def get_payment(ctx: click.Context, company_id: str, payment: str, json: bool =
     client = ctx.obj
     payment_result = client.get_payment(company_id, payment)
     payment_result_json = payment_result.json()
-    viewer = ViewerDispatcher(data=payment_result_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=payment_result_json, json_flag=json, data_type="Payment"
+    )
     viewer()

src/clidat/commands/platform.py

@@ -16,7 +16,7 @@ def get_company(ctx: click.Context, company_id: str, json: bool = False):
     client = ctx.obj
     company = client.get_company(company_id)
     company_json = company.json()
-    viewer = ViewerDispatcher(data=company_json, json_flag=json)
+    viewer = ViewerDispatcher(data=company_json, json_flag=json, data_type="Company")
     viewer()
 
 
@@ -36,7 +36,9 @@ def get_companies(
         page_size=page_size, page_number=page_number, query=query, order_by=order_by
     )
     companies_json = companies.json()
-    viewer = ViewerDispatcher(data=companies_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=companies_json, json_flag=json, data_type="List of Companies"
+    )
     viewer()
 
 
@@ -47,7 +49,9 @@ def get_sync_settings(ctx: click.Context, company_id: str, json: bool = False):
     client = ctx.obj
     sync_settings = client.get_sync_settings(company_id)
     sync_settings_json = sync_settings.json()
-    viewer = ViewerDispatcher(data=sync_settings_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=sync_settings_json, json_flag=json, data_type="Sync Settings"
+    )
     viewer()
 
 
@@ -72,7 +76,9 @@ def get_connections(
         order_by=order_by,
     )
     connections_json = connections.json()
-    viewer = ViewerDispatcher(data=connections_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=connections_json, json_flag=json, data_type="List of Connections"
+    )
     viewer()
 
 
@@ -86,7 +92,9 @@ def get_connection(
     client = ctx.obj
     connection_result = client.get_connection(company_id, connection)
     connection_result_json = connection_result.json()
-    viewer = ViewerDispatcher(data=connection_result_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=connection_result_json, json_flag=json, data_type="Connection"
+    )
     viewer()
 
 
@@ -111,7 +119,9 @@ def get_datasets(
         order_by=order_by,
     )
     datasets_json = datasets.json()
-    viewer = ViewerDispatcher(data=datasets_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=datasets_json, json_flag=json, data_type="List of Datasets"
+    )
     viewer()
 
 
@@ -123,7 +133,9 @@ def get_dataset(ctx, company_id, dataset, json: bool = False):
     client = ctx.obj
     dataset_result = client.get_data_set(company_id, dataset)
     dataset_result_json = dataset_result.json()
-    viewer = ViewerDispatcher(data=dataset_result_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=dataset_result_json, json_flag=json, data_type="Dataset"
+    )
     viewer()
 
 
@@ -134,5 +146,7 @@ def get_data_status(ctx: click.Context, company_id: str, json: bool = False):
     client = ctx.obj
     data_status = client.get_data_status(company_id)
     data_status_json = data_status.json()
-    viewer = ViewerDispatcher(data=data_status_json, json_flag=json)
+    viewer = ViewerDispatcher(
+        data=data_status_json, json_flag=json, data_type="Data Status"
+    )
     viewer()

src/clidat/tui/viewer.py

@@ -9,15 +9,16 @@
 
 
 class ViewerDispatcher:
-    def __init__(self, data: str, json_flag: bool = False):
+    def __init__(self, data: str, data_type: str, json_flag: bool = False):
         self.data = data
         self.json = json_flag
+        self.data_type = data_type
 
     def __call__(self, *args, **kwargs):
         if self.json:
             return JSONViewer(self.data).run()
         else:
-            return TreeViewer(self.data).run()
+            return TreeViewer(self.data, self.data_type).run()
 
 
 class JSONViewer(TUIApp):
@@ -38,17 +39,18 @@ class TreeViewer(TUIApp):
     # This has been altered very little from the Textual 'JSON tree' Example:
     # https: // github.com / Textualize / textual / blob / main / examples / json_tree.py
 
-    def __init__(self, data: str):
+    def __init__(self, data: str, data_type: str):
         super().__init__()
         self.data = json.loads(data)
+        self.data_type = data_type
 
     def compose(self) -> ComposeResult:
         yield Header()
         yield Footer()
-        yield Tree("Root")
+        yield Tree("Codat API Response")
 
     @classmethod
-    def add_json(cls, node: TreeNode, json_data: object) -> None:
+    def add_json(cls, node: TreeNode, json_data: object, data_type: str) -> None:
         """Adds JSON data to a node.
         Args:
             node (TreeNode): A Tree node.
@@ -86,10 +88,10 @@ def add_node(name: str, node: TreeNode, data: object) -> None:
                     label = Text(repr(data))
                 node.set_label(label)
 
-        add_node("JSON", node, json_data)
+        add_node(data_type, node, json_data)
 
     def on_mount(self) -> None:
         tree = self.query_one(Tree)
         json_node = tree.root.add("JSON")
-        self.add_json(json_node, self.data)
+        self.add_json(json_node, self.data, self.data_type)
         tree.root.expand()