Update documentation and help texts

src/floridayvine/commands/about.py

@@ -8,7 +8,10 @@
     check_database_status,
 )
 
-app = typer.Typer(invoke_without_command=True)
+app = typer.Typer(
+    invoke_without_command=True,
+    help="Display information about the Floriday Vine command line interface.",
+)
 
 
 def get_version():

src/floridayvine/commands/database.py

@@ -1,7 +1,7 @@
 import typer
 from ..persistence import initialize_database
 
-app = typer.Typer()
+app = typer.Typer(help="Database management commands.")
 
 
 @app.command()

src/floridayvine/commands/inventory.py

@@ -4,9 +4,8 @@
     get_trade_items,
     get_direct_sales,
 )
-from . import sync
 
-app = typer.Typer()
+app = typer.Typer(help="Inventory management commands.")
 
 
 @app.command()
@@ -25,6 +24,3 @@ def list_trade_items():
     """
     trade_items = get_trade_items()
     pprint(trade_items)
-
-
-app.add_typer(sync.app, name="sync")

src/floridayvine/commands/sync.py

@@ -3,11 +3,14 @@
 from ..persistence import print_sync_status as persistence_print_sync_status
 
 
-app = typer.Typer()
+app = typer.Typer(help="Synchronize collections in the local database with Floriday.")
 
 
 @app.command()
 def status():
+    """
+    Display the synchronization status for all synchronized collections.
+    """
     persistence_print_sync_status()
 
 

work/backlog.md

@@ -6,9 +6,9 @@
 
 * Goal: Cleanup codebase and do the first deploy to a Serra Vine environment
   * (Should, L) Deploy to a Serra Vine production system.
-    - Execute production deployment
-    - Verify functionality in production environment
-    - Acceptance: Application successfully deployed and running in Serra Vine production system
+    * Execute production deployment
+    * Verify functionality in production environment
+    * Acceptance: Application successfully deployed and running in Serra Vine production system
 
 ## Later
 
@@ -20,16 +20,16 @@
 * Create a local catalog
   * Copy trade items
   * Translate vbn codes
-  * Download images 
+  * Download images
 
 ## Out of Scope
 
 ## Done
 
 * Address integration test failures
-  - Review and update integration test setup
-  - Ensure development environment is properly configured for integration tests
-  - Document the process for setting up the environment for integration tests
+  * Review and update integration test setup
+  * Ensure development environment is properly configured for integration tests
+  * Document the process for setting up the environment for integration tests
 * Prepare deployment documentation and configuration files
 * Set up necessary credentials and access for production environment
 * Configure CI/CD pipeline for automated deployment