Merge pull request #1 from pj-simpson/textual_spike

Rip out Urwid based-TUI, replace with Textual

Author: pj-simpson

README.md

@@ -4,7 +4,7 @@ CLIdat is a tool for inspecting Data from Codat.
 
 The Command Line Interface itself is written with [Click](https://github.com/pallets/click),
 whilst the output of the different commands is passed to
-a TUI from the [Pyfx](https://github.com/cielong/pyfx) package.
+a TUI from the [Textual](https://github.com/Textualize/textual) package.
 
 I work in support at Codat, and have built this tool as a personal project
 to help with my day-job. This isn't an officially 
@@ -18,17 +18,18 @@ it inside a [virtual environment](https://docs.python.org/3/library/venv.html)
 ```console
 (venv) user@host:~$ pip install clidat
 ```
-This software will only work on MacOS or Linux. Cygwin and WSL do not yield good results, either.  
+Thanks to Textual, this software is cross-platform and
+should work well on Windows, Linux and MacOS. 
 
 ## Quick Start
 
 ```console
 (venv) user@host:~$ clidat auth
 Your Codat API Key:
 
-(venv) user@host:~$ clidat get-companies
+(venv) user@host:~$ clidat get-suppliers -id 2e14de3b-e2cf-4745-af24-a9a082b4c466
 ```
-![Clidat Get Companies](./clidat_get_companies_image.png)
+![Clidat Get Companies](./clidat_get_suppliers_image.png)
 
 
 ## Docs
@@ -52,8 +53,10 @@ flag  onto the end of the command, for example:
 Options:
   --payment TEXT          [required]
   -id, --company-id TEXT  [required]
+  -j, --json              View plain JSON response
   --help                  Show this message and exit.
 
 
+
 ```
 

clidat_get_companies_image.png

@@ -10,7 +10,7 @@ readme = "README.md"
 python = "^3.10"
 click = "^8.1.3"
 pycompanydata = "^0.1.2"
-python-fx = "^0.2.0"
+textual = "^0.18.0"
 
 
 [tool.poetry.group.dev.dependencies]

clidat_get_suppliers_image.png

@@ -1,5 +1,4 @@
 import click
-from pyfx import PyfxApp
 
 from clidat.meta import (
     company_and_connection_ids_required,
@@ -8,6 +7,8 @@
     company_id_required_with_pagination,
 )
 
+from ..tui.viewer import ViewerDispatcher
+
 
 @click.command("get-accounts")
 @click.pass_context
@@ -19,6 +20,7 @@ def get_accounts(
     page_number: int,
     query: str,
     order_by: str,
+    json: bool = False,
 ):
     client = ctx.obj
     accounts = client.get_accounts_page(
@@ -28,17 +30,25 @@ def get_accounts(
         query=query,
         order_by=order_by,
     )
-    PyfxApp(data=accounts).run()
+    accounts_json = accounts.json()
+    viewer = ViewerDispatcher(
+        data=accounts_json, json_flag=json, data_type="Chart of Accounts"
+    )
+    viewer()
 
 
 @click.command("get-account")
 @click.pass_context
 @click.option("--account", required=True, type=str)
 @company_id_required
-def get_account(ctx: click.Context, company_id: str, account: str):
+def get_account(ctx: click.Context, company_id: str, account: str, json: bool = False):
     client = ctx.obj
     account_result = client.get_account(company_id, account)
-    PyfxApp(data=account_result).run()
+    account_result_json = account_result.json()
+    viewer = ViewerDispatcher(
+        data=account_result_json, json_flag=json, data_type="Accounts"
+    )
+    viewer()
 
 
 @click.command("get-account-transactions")
@@ -52,6 +62,7 @@ def get_account_transactions(
     page_number: int,
     query: str,
     order_by: str,
+    json: bool = False,
 ):
     client = ctx.obj
     account_transactions = client.get_account_transactions_page(
@@ -62,21 +73,37 @@ def get_account_transactions(
         query=query,
         order_by=order_by,
     )
-    PyfxApp(data=account_transactions).run()
+    account_transactions_json = account_transactions.json()
+    viewer = ViewerDispatcher(
+        data=account_transactions_json,
+        json_flag=json,
+        data_type="List of Account Transactions",
+    )
+    viewer()
 
 
 @click.command("get-account-transaction")
 @click.pass_context
 @click.option("--account-transaction", required=True, type=str)
 @company_and_connection_ids_required
 def get_account_transaction(
-    ctx: click.Context, company_id: str, connection: str, account_transaction: str
+    ctx: click.Context,
+    company_id: str,
+    connection: str,
+    account_transaction: str,
+    json: bool = False,
 ):
     client = ctx.obj
     account_transaction_result = client.get_account_transaction(
         company_id, connection, account_transaction
     )
-    PyfxApp(data=account_transaction_result).run()
+    account_transaction_result_json = account_transaction_result.json()
+    viewer = ViewerDispatcher(
+        data=account_transaction_result_json,
+        json_flag=json,
+        data_type="Account Transaction",
+    )
+    viewer()
 
 
 @click.command("get-bills")
@@ -89,6 +116,7 @@ def get_bills(
     page_number: int,
     query: str,
     order_by: str,
+    json: bool = False,
 ):
     client = ctx.obj
     bills = client.get_bills_page(
@@ -98,17 +126,23 @@ def get_bills(
         query=query,
         order_by=order_by,
     )
-    PyfxApp(data=bills).run()
+    bills_json = bills.json()
+    viewer = ViewerDispatcher(
+        data=bills_json, json_flag=json, data_type="List of Bills"
+    )
+    viewer()
 
 
 @click.command("get-bill")
 @click.pass_context
 @click.option("--bill", required=True, type=str)
 @company_id_required
-def get_bill(ctx: click.Context, company_id: str, bill: str):
+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)
-    PyfxApp(data=bill_result).run()
+    bill_result_json = bill_result.json()
+    viewer = ViewerDispatcher(data=bill_result_json, json_flag=json, data_type="Bills")
+    viewer()
 
 
 @click.command("get-suppliers")
@@ -121,6 +155,7 @@ def get_suppliers(
     page_number: int,
     query: str,
     order_by: str,
+    json: bool = False,
 ):
     client = ctx.obj
     suppliers = client.get_suppliers_page(
@@ -130,17 +165,27 @@ def get_suppliers(
         query=query,
         order_by=order_by,
     )
-    PyfxApp(data=suppliers).run()
+    suppliers_json = suppliers.json()
+    viewer = ViewerDispatcher(
+        data=suppliers_json, json_flag=json, data_type="List of Suppliers"
+    )
+    viewer()
 
 
 @click.command("get-supplier")
 @click.pass_context
 @click.option("--supplier", required=True, type=str)
 @company_id_required
-def get_supplier(ctx: click.Context, company_id: str, supplier: str):
+def get_supplier(
+    ctx: click.Context, company_id: str, supplier: str, json: bool = False
+):
     client = ctx.obj
     supplier_result = client.get_supplier(company_id, supplier)
-    PyfxApp(data=supplier_result).run()
+    supplier_result_json = supplier_result.json()
+    viewer = ViewerDispatcher(
+        data=supplier_result_json, json_flag=json, data_type="Supplier"
+    )
+    viewer()
 
 
 @click.command("get-invoices")
@@ -153,6 +198,7 @@ def get_invoices(
     page_number: int,
     query: str,
     order_by: str,
+    json: bool = False,
 ):
     client = ctx.obj
     invoices = client.get_invoices_page(
@@ -162,17 +208,25 @@ def get_invoices(
         query=query,
         order_by=order_by,
     )
-    PyfxApp(data=invoices).run()
+    invoices_json = invoices.json()
+    viewer = ViewerDispatcher(
+        data=invoices_json, json_flag=json, data_type="List of Invoices"
+    )
+    viewer()
 
 
 @click.command("get-invoice")
 @click.pass_context
 @click.option("--invoice", required=True, type=str)
 @company_id_required
-def get_invoice(ctx: click.Context, company_id: str, invoice: str):
+def get_invoice(ctx: click.Context, company_id: str, invoice: str, json: bool = False):
     client = ctx.obj
     invoice_result = client.get_invoice(company_id, invoice)
-    PyfxApp(data=invoice_result).run()
+    invoice_result_json = invoice_result.json()
+    viewer = ViewerDispatcher(
+        data=invoice_result_json, json_flag=json, data_type="Invoice"
+    )
+    viewer()
 
 
 @click.command("get-payments")
@@ -185,6 +239,7 @@ def get_payments(
     page_number: int,
     query: str,
     order_by: str,
+    json: bool = False,
 ):
     client = ctx.obj
     payments = client.get_payment_page(
@@ -194,14 +249,22 @@ def get_payments(
         query=query,
         order_by=order_by,
     )
-    PyfxApp(data=payments).run()
+    payments_json = payments.json()
+    viewer = ViewerDispatcher(
+        data=payments_json, json_flag=json, data_type="List of Payments"
+    )
+    viewer()
 
 
 @click.command("get-payment")
 @click.pass_context
 @click.option("--payment", required=True, type=str)
 @company_id_required
-def get_payment(ctx: click.Context, company_id: str, payment: str):
+def get_payment(ctx: click.Context, company_id: str, payment: str, json: bool = False):
     client = ctx.obj
     payment_result = client.get_payment(company_id, payment)
-    PyfxApp(data=payment_result).run()
+    payment_result_json = payment_result.json()
+    viewer = ViewerDispatcher(
+        data=payment_result_json, json_flag=json, data_type="Payment"
+    )
+    viewer()