split 'sup' command so that 'sup' is read-only and 'did' modifies today's checklist. Other organizations and new 'nvm' command specs

Author: tensorturtle

src/fob/__init__.py

@@ -55,7 +55,13 @@ def run_app():
     )
     subparsers.add_parser("reset", help="Reset fob by deleting persistent database file.")
     subparsers.add_parser("sup", help="Quick look at the month and today's blocks")
-
+    did_parser = subparsers.add_parser("did", help="Check off blocks from today's checklist")
+    did_parser.add_argument(
+        "block_id",
+        type=str,
+        help="ID of the block to check off (int)",
+    )
+    subparsers.add_parser("nvm", help="Revise block assignment for today and change a non-Buffer block into a Buffer block, and mark that new Buffer block as complete."
     args = parser.parse_args()
 
     command_func = None

src/fob/commands/__init__.py

@@ -4,3 +4,4 @@
 from fob.commands.sup import sup
 from fob.commands.new_month import new_month
 from fob.commands.reset import reset
+from fob.commands.did import did

src/fob/commands/did.py

@@ -0,0 +1,58 @@
+from rich.pretty import pprint
+from rich import print
+
+from fob.commands.overviews import display_checklist
+from fob.db import checklist_complete
+
+
+def did(args, db):
+    '''
+    Quickly check off a block from the day's checklist.
+
+    The user is expected to run `fob sup` prior to running this command,
+    which displays the month overview and the day's checklist.
+    Then, the user can run `fob did <number>` to mark a the numbered block as completed.
+    This command displays the updated checklist after marking the block as completed.
+    Visually, it would exactly replace where the day's checklist was previously displayed,
+    making it look like it was a GUI refresh.
+
+    args.block_id: str - contains the block number to mark as completed. The keys are str, so we just use str-ified ints.
+    '''
+    try:
+        checklist = db.all()[0]['checklist']
+    except IndexError:
+        print("[red][bold]No day data found.[/red][/bold]")
+        print("Run [cyan][bold]fob gm[/cyan][/bold] to start a new day.")
+        return
+    if args.debug:
+        print("Checklist from DB:")
+        pprint(checklist)
+
+    if checklist_complete(db):
+        print("\n[green]All blocks have already been completed. No changes made.[/green]")
+        print("Start a new day: [green bold]fob gm[/green bold]")
+        return
+
+    # check that the block_id is within range
+    try:
+        checklist[args.block_id].update({"done": True})
+    except KeyError:
+        print("[red][bold]Invalid block number.[/red][/bold]")
+        return
+
+    db.update({"checklist": checklist}, None)
+
+    if args.debug:
+        print("Updated checklist:")
+        pprint(checklist)
+
+    # display updated checklist
+    display_checklist(args, db)
+
+
+    if checklist_complete(db):
+        print("[green]All blocks have been completed![/green]")
+        print("Start a new day: [green bold]fob gm[/green bold]")
+        return
+    else:
+        print("[green]Checklist updated.[/green] See overview: [cyan]fob sup[/cyan]")

src/fob/commands/gm.py

@@ -14,8 +14,7 @@
 from tinydb import where, Query
 
 from fob.db import MonthBlockData, TinyDBWrapper, checklist_complete
-from fob.commands.overviews import month_overview
-from fob.commands.user_flows import display_checklist
+from fob.commands.overviews import month_overview, display_checklist
 
 class InvalidUserInput(Exception):
     '''
@@ -52,7 +51,8 @@ def gm(args: Namespace, db: TinyDBWrapper) -> None:
     print("[bold]Today's Checklist:[/bold]")
     display_checklist(args, db)
 
-    print("Run [cyan][bold]fob sup[/cyan][/bold] to track daily progress and to see the month overview again.")
+    print("Next commands: [cyan][bold]fob sup[/cyan][/bold] to see the above overviews again.")
+    print("[green][bold]fob did (number) [/green][/bold] to mark a block as done.")
 
 
 def new_day(args: Namespace, db: TinyDBWrapper, data) -> None:

src/fob/commands/help.py

@@ -19,4 +19,5 @@ def help(args: Namespace | None, db: TinyDBWrapper | None) -> None:
 [green bold]Global Options:[/green bold]
     [cyan bold]-d, --database[/cyan bold] [magenta not bold]<PATH_TO_DB_FILE>[/magenta not bold]  Path to database file. You can use a cloud storage (eg. Dropbox) to sync the database across devices.
     [cyan bold]-x, --debug[/cyan bold]  Enable debug mode.
-""")
+
+First time with fob? Start by running [green][bold]fob new_month[/green][/bold] to allocate blocks for the month.""")

src/fob/commands/new_month.py

@@ -16,8 +16,7 @@ def new_month(args: Namespace, db: TinyDBWrapper) -> None:
     if result is not None:
         write_new_month(result, db)
         print("\n[green]New month successfully created![/green]")
-        print("Next steps:")
-        print("\t[green bold]fob gm[/green bold]: Start your day with the good morning command.")
+        print("Next commands: [green bold]fob gm[/green bold] - Start your day with the good morning command.")
 
 def write_new_month(data: MonthBlockData, db: TinyDBWrapper) -> None:
     areas = {}
@@ -81,42 +80,43 @@ def converse_with_user(args: Namespace) ->MonthBlockData:
         )
         today = today.replace(day=1)
         today = today.replace(month=today.month + 1)
-    year = Prompt.ask("\n\tWhat year?", default=str(today.year))
-    month = Prompt.ask("\tWhat month?", default=str(today.month))
+    year = Prompt.ask("\nWhat year?", default=str(today.year))
+    month = Prompt.ask("What month?", default=str(today.month))
 
     days_in_month = monthrange(int(year), int(month))[1]
 
     if args.debug:
         print(f"\nAllocating blocks for {year}/{month}, which has {days_in_month} days.")
 
     working_days = Prompt.ask(
-        "\n\tHow many working days?", default=str(days_in_month - 8)
+        "How many working days?", default=str(days_in_month - 8)
     )
     if int(working_days) > days_in_month or int(working_days) <= 0:
         print(
             "[red bold]Error:[/red bold] Invalid number of working days. Please try again."
         )
 
     if args.debug:
-        print(f"\nYou have chosen {working_days} working days.")
+        print(f"You have chosen {working_days} working days.")
 
-    blocks_per_day = Prompt.ask("\n\tHow many blocks per day?", default="5")
+    blocks_per_day = Prompt.ask("How many blocks per day?", default="5")
     total_blocks = int(working_days) * int(blocks_per_day)
+    print("---")
     print(
-        f"\nYou have chosen {blocks_per_day} blocks per day, for a total of {total_blocks} blocks."
+        f"You have chosen {blocks_per_day} blocks per day, for a total of {total_blocks} blocks.\n"
     )
 
-    print("\nWhich areas will you be working on?")
+    print("Which areas will you be working on?")
     areas = []
 
     while True:
-        area = Prompt.ask("\tNew Focus Area (enter empty to finish)", default="")
+        area = Prompt.ask("New Focus Area (enter empty to finish)", default="")
         if area == "":
             break
         areas.append(area)
 
     if args.debug:
-        print(f"\nYou have chosen the following areas: {', '.join(areas)}")
+        print(f"You have chosen the following areas: {', '.join(areas)}")
 
     blocks_per_area = {}
     for area in areas:
@@ -125,7 +125,7 @@ def converse_with_user(args: Namespace) ->MonthBlockData:
     areas.append("Buffer")
     default_buffer = min(8, total_blocks)
     buffer_blocks = Prompt.ask(
-        "\n\tHow many blocks for Buffer?", default=str(default_buffer)
+        "How many blocks for Buffer?", default=str(default_buffer)
     )
     blocks_per_area.update({"Buffer": int(buffer_blocks)})
 
@@ -135,12 +135,12 @@ def converse_with_user(args: Namespace) ->MonthBlockData:
             break
         remaining_blocks = total_blocks - sum(blocks_per_area.values())
         if args.debug:
-            print(f"\nYou have {remaining_blocks} blocks remaining.")
+            print(f"You have {remaining_blocks} blocks remaining.")
         display_blocks_table(blocks_per_area, area)
         equal_split_from_remaining = remaining_blocks // (len(areas) - i - 1)
         blocks_for_area = int(
             Prompt.ask(
-                f"\tHow many blocks for {area}?",
+                f"How many blocks for {area}?",
                 default=str(equal_split_from_remaining),
             )
         )

src/fob/commands/nvm.py

@@ -0,0 +1,14 @@
+from argparse import Namespace
+
+from fob.db.wrapper import TinyDBWrapper
+
+
+def nvm(args: Namespace, db: TinyDBWrapper):
+    '''
+    'nvm' command: Abbreviation for 'Nevermind" - used to convert a non-Buffer block into a Buffer block.
+
+    The user would run `fob sup` to see today's checklist.
+    If they succeed in completing a block, they would run `fob did (number)` to mark the block as done.
+    However, if they fail to do meaningful work on a block, or somehow circumstances made it so that they couldn't do the work assigned in that block, they can run `fob nvm (number)` to convert the block into a Buffer block and mark it as a complete Buffer block. Normally this kind of assignment is done one time at the beginning of the day through `fob gm`, but this command lets us override that.
+    '''
+    raise NotImplementedError("This command has not been implemented yet.")

src/fob/commands/overviews/__init__.py

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

src/fob/commands/overviews/day_checklist.py

@@ -0,0 +1,21 @@
+from argparse import Namespace
+
+from rich.pretty import pprint
+from rich import print
+from rich.panel import Panel
+
+from fob.db import TinyDBWrapper
+
+def display_checklist(args: Namespace, db: TinyDBWrapper) -> None:
+    try:
+        checklist = db.all()[0]['checklist']
+    except KeyError:
+        print("[red][bold]No day data found.[/red][/bold]")
+        print("Run [cyan][bold]fob gm[/cyan][/bold] to start a new day.")
+        return
+    if args.debug:
+        print("Checklist from DB:")
+        pprint(checklist)
+    # print the checklist
+    for num, info in checklist.items():
+        print(Panel(f"{num}: {info['name']}", border_style="bold green" if info['done'] else "bold red"))

src/fob/commands/overviews/month_overview.py

@@ -3,6 +3,7 @@
 from calendar import monthrange
 
 from tinydb import where
+from rich.pretty import pprint
 from rich.console import Console, Group
 from rich.panel import Panel
 from rich.progress import Progress, BarColumn, TaskProgressColumn, TextColumn, ProgressColumn