feat: refactor, utilize 'rich'

Author: druwan

pyproject.toml

@@ -23,10 +23,11 @@ dependencies = [
   "python-dotenv>=1.1.0",
   "pytz==2024.1",
   "requests==2.32.3",
+  "rich>=14.3.3",
+  "rich-argparse>=1.7.2",
   "ruff>=0.11.7",
   "shapely==2.0.3",
   "six==1.16.0",
-  "tabulate>=0.9.0",
   "tenacity>=9.1.2",
   "tzdata==2024.1",
   "urllib3==2.2.3",

src/coord_buffer_cli/cli.py

@@ -1,59 +1,33 @@
-import argparse
-
+from coord_buffer_cli.config import logger, parse_args
 from coord_buffer_cli.utils import (
     buffer_polygon,
     list_coords_from_db,
-    logger,
+    print_coordinates,
     read_coords,
     read_coords_from_db,
-    to_dms_coords,
 )
 
 
-def parse_args():
-    parser = argparse.ArgumentParser(
-        description="Creates a specified buffer around user specified area."
-    )
-    parser.add_argument(
-        "-l",
-        "--list",
-        action="store_true",
-        help="Prints list of available geometries and their id.",
-    )
-    parser.add_argument(
-        "--msid",
-        default=None,
-        help="Get coords for the selected geometries.",
-    )
-    parser.add_argument(
-        "-f",
-        "--input_file",
-        default=None,
-        help="Path to a GeoJSON file with coordinates",
-    )
-    parser.add_argument(
-        "-b", "--buffer", type=float, default=0, help="Buffer size in NM (default: 0)"
-    )
-    return parser.parse_args()
-
-
 def main():
     args = parse_args()
 
     try:
         if args.list:
             list_coords_from_db()
             return
-        elif args.msid:
-            logger.info(f"Processing msid: {args.msid}")
+
+        if args.msid:
+            logger.info(f"Processing MSID: {args.msid}")
             coords = read_coords_from_db(args.msid)
-        elif args.input_file:
-            logger.info(f"Processing input file: {args.input_file}")
+        else:
+            logger.info(f"Processing file: {args.input_file}")
             coords = read_coords(args.input_file)
+
         buffered_gdf = buffer_polygon(coords, args.buffer)
         coords_df = buffered_gdf.get_coordinates()
-        for _, row in coords_df.iterrows():
-            print(to_dms_coords([row["y"], row["x"]]))
+
+        print_coordinates(coords_df)
+
     except Exception as e:
         logger.error(f"Error processing file: {e}")
         return

src/coord_buffer_cli/config.py

@@ -1,6 +1,11 @@
+import argparse
+import logging
 import os
 
 from dotenv import load_dotenv
+from rich.console import Console
+from rich.logging import RichHandler
+from rich_argparse import RichHelpFormatter
 
 load_dotenv()
 
@@ -15,3 +20,51 @@
     "host": os.getenv("POSTGRES_HOST"),
     "port": os.getenv("5432"),
 }
+
+
+logging.basicConfig(level="INFO", format="%(message)s", handlers=[RichHandler()])
+logger = logging.getLogger(__name__)
+
+console = Console()
+
+
+class CustomFormatter(RichHelpFormatter):
+    styles = {
+        "argparse.prog": "bold cyan",
+        "argparse.args": "cyan",
+        "argparse.metavar": "yellow",
+        "argparse.help": "white",
+    }
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(
+        prog="coord_buffer_cli",
+        description="Creates a specified buffer around user specified area.",
+        epilog="Ex: uv run coord_buffer_cli --msid 3982 -b 5",
+        formatter_class=CustomFormatter,
+    )
+    source_group = parser.add_mutually_exclusive_group(required=True)
+
+    source_group.add_argument(
+        "-l",
+        "--list",
+        action="store_true",
+        help="Prints list of available geometries and their id.",
+    )
+
+    source_group.add_argument(
+        "--msid",
+        type=int,
+        help="Fetch coordinates for the given MSID.",
+    )
+
+    source_group.add_argument(
+        "-f",
+        "--input_file",
+        help="Path to a GeoJSON file.",
+    )
+    parser.add_argument(
+        "-b", "--buffer", type=float, default=0.0, help="Buffer size in nautical miles."
+    )
+    return parser.parse_args()

src/coord_buffer_cli/utils.py

@@ -1,22 +1,29 @@
 import json
-import logging
 import re
 import unicodedata
 
 import geopandas as gpd
 import psycopg
+from rich.table import Table
+from rich.text import Text
 from shapely.geometry import Polygon
-from tabulate import tabulate
 
 from coord_buffer_cli.config import (
     BUFFER_MULTIPLIER,
     DB_PARAMS,
     DEFAULT_EPSG,
     METRIC_EPSG,
+    console,
 )
 
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
+
+def print_coordinates(coord_dataframe):
+    console.print(f"\n[bold green]Buffered Polygon • {args.buffer} NM[/bold green]\n")
+    for _, row in coord_dataframe.iterrows():
+        dms = to_dms_coords([row["y"], row["x"]])
+        lat, lon = dms.split()
+        line = Text.assemble((lat, "yellow"), (" ", ""), (lon, "cyan"))
+        console.print(line)
 
 
 def clean_file_name(name):
@@ -100,11 +107,16 @@ def list_coords_from_db():
             if not rows:
                 raise ValueError("No geometries found")
 
-            print(
-                tabulate(
-                    rows, headers=["MSID", "TMA"], tablefmt="pretty", colalign=("left",)
-                )
-            )
+            table = Table(title="Available TMAs", header_style="bold magenta")
+            table.add_column("MSID", style="cyan", justify="center")
+            table.add_column("TMA", style="green", justify="left")
+
+            for (
+                msid,
+                name,
+            ) in rows:
+                table.add_row(str(msid), name)
+            console.print(table)
             return rows