reorganized shared components into overviews (read only) and user_flows (mutates db)

Author: tensorturtle

src/fob/__init__.py

@@ -1,3 +1,4 @@
+# This is the main entry point for the application.
 import sys
 import argparse
 from dataclasses import dataclass

src/fob/commands/__init__.py

@@ -1,3 +1,4 @@
+# Each module in this 'commands' directory has an identically named function that is called by the main.py script.
 from fob.commands.help import help
 from fob.commands.gm import gm
 from fob.commands.sup import sup

src/fob/commands/components/__init__.py

@@ -4,7 +4,8 @@
 
 from rich.pretty import pprint, Pretty
 from rich import print
-from rich.layout import Layout, Panel
+from rich.layout import Layout
+from rich.panel import Panel
 from rich.progress import Progress, TextColumn, BarColumn, TaskProgressColumn, ProgressColumn
 from rich.console import Console, Group
 from rich.rule import Rule
@@ -13,7 +14,8 @@
 from tinydb import where, Query
 
 from fob.db import MonthBlockData, TinyDBWrapper, checklist_complete
-from fob.commands.components import month_overview, display_checklist
+from fob.commands.overviews import month_overview
+from fob.commands.user_flows import display_checklist
 
 class InvalidUserInput(Exception):
     '''

src/fob/commands/gm.py

@@ -0,0 +1,2 @@
+# This 'overviews' directory contains read-only visualizations of database content
+from fob.commands.overviews.month_overview import *

src/fob/commands/overviews/__init__.py

@@ -1,7 +1,8 @@
 from argparse import Namespace
 
 from fob.db import TinyDBWrapper
-from fob.commands.components import month_overview, day_checklist
+from fob.commands.overviews import month_overview
+from fob.commands.user_flows import day_checklist
 
 def sup(args: Namespace, db: TinyDBWrapper) -> None:
     month_overview(args, db)

src/fob/commands/components/month_overview.py renamed to src/fob/commands/overviews/month_overview.py

@@ -0,0 +1,2 @@
+# This user_flows directory contains sequential user interactive flows that modify the database
+from fob.commands.user_flows.day_checklist import *