taskcheck 0.1.2__tar.gz → 0.1.3__tar.gz

{taskcheck-0.1.2/taskcheck.egg-info → taskcheck-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: taskcheck
-Version: 0.1.2
+Version: 0.1.3
 Summary: Automatic scheduler for taskwarrior
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -45,6 +45,8 @@ You can exclude a task from being scheduled by removing the `time_map` or `estim
 
 You can see tasks that you can execute now with the `task ready` report.
 
+You can see the schedule for a task in the `scheduling` UDA.
+
 ## Configuration
 
 1. Create a TOML file at `~/.config/task/taskcheck.toml` with the following format:
@@ -90,6 +92,8 @@ uda.estimated.type = duration
 uda.estimated.label = Estimated Time
 uda.completion_date.type = date
 uda.completion_date.label = Expected Completion Date
+uda.scheduling.type = string
+uda.scheduling.label = Scheduling
 
 # Adjust urgency for taskcheck
 # you will use `wait:` to avoid scheduling tasks too much sooner
@@ -106,7 +110,7 @@ urgency.inherit=1 # use dependencies to automatically prioritize tasks
 urgency.blocking.coefficient=2
 
 # give urgeny values to the estimated time
-# this is ln(estimation)
+# this is log(estimation) + 1, with base so that 36 hours has ~12 urgency
 urgency.uda.estimated.PT1H.coefficient = 1
 urgency.uda.estimated.PT2H.coefficient = 2.32
 urgency.uda.estimated.PT3H.coefficient = 3.67
@@ -152,6 +156,5 @@ urgency.uda.estimated.PT36H.coefficient = 11.96
 ```
 
 -v, --verbose: increase output verbosity
--t, --today: how much time has been already used today (default: 0)
 
 ```

{taskcheck-0.1.2 → taskcheck-0.1.3}/README.md

@@ -34,6 +34,8 @@ You can exclude a task from being scheduled by removing the `time_map` or `estim
 
 You can see tasks that you can execute now with the `task ready` report.
 
+You can see the schedule for a task in the `scheduling` UDA.
+
 ## Configuration
 
 1. Create a TOML file at `~/.config/task/taskcheck.toml` with the following format:
@@ -79,6 +81,8 @@ uda.estimated.type = duration
 uda.estimated.label = Estimated Time
 uda.completion_date.type = date
 uda.completion_date.label = Expected Completion Date
+uda.scheduling.type = string
+uda.scheduling.label = Scheduling
 
 # Adjust urgency for taskcheck
 # you will use `wait:` to avoid scheduling tasks too much sooner
@@ -95,7 +99,7 @@ urgency.inherit=1 # use dependencies to automatically prioritize tasks
 urgency.blocking.coefficient=2
 
 # give urgeny values to the estimated time
-# this is ln(estimation)
+# this is log(estimation) + 1, with base so that 36 hours has ~12 urgency
 urgency.uda.estimated.PT1H.coefficient = 1
 urgency.uda.estimated.PT2H.coefficient = 2.32
 urgency.uda.estimated.PT3H.coefficient = 3.67
@@ -141,6 +145,5 @@ urgency.uda.estimated.PT36H.coefficient = 11.96
 ```
 
 -v, --verbose: increase output verbosity
--t, --today: how much time has been already used today (default: 0)
 
 ```

{taskcheck-0.1.2 → taskcheck-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "taskcheck"
-version = "0.1.2"
+version = "0.1.3"
 description = "Automatic scheduler for taskwarrior"
 readme = "README.md"
 requires-python = ">=3.11"

{taskcheck-0.1.2 → taskcheck-0.1.3}/taskcheck/__main__.py

@@ -11,14 +11,6 @@ from taskcheck.ical import ical_to_dict
 config_dir = Path(appdirs.user_config_dir("task"))
 
 arg_parser = argparse.ArgumentParser()
-arg_parser.add_argument(
-    "-t",
-    "--today",
-    type=float,
-    action="store",
-    help="specify how many hours you have already worked today (default: 0)",
-    default=0,
-)
 arg_parser.add_argument(
     "-v", "--verbose", action="store_true", help="increase output verbosity"
 )
@@ -59,6 +51,7 @@ def _hours_to_time(hour):
 
 
 def _time_to_decimal(time):
+    # round to 2 digits after the point
     return time.hour + time.minute / 60
 
 
@@ -142,7 +135,20 @@ def get_long_range_time_map(time_maps, time_map_names, days_ahead, calendars):
             task_time_map.append(daily_hours)
         long_range_time_map[key] = task_time_map
 
-    return task_time_map
+    today_time = _time_to_decimal(datetime.now().time())
+    today_weekday = datetime.today().strftime("%A").lower()
+    today_used_hours = 0
+    # compare with the time_maps of today
+    for time_map_name in time_map_names:
+        time_map = time_maps[time_map_name].get(today_weekday)
+        if time_map:
+            for schedule_start, schedule_end in time_map:
+                if schedule_start <= today_time <= schedule_end:
+                    today_used_hours += today_time - schedule_start
+                    break
+                elif today_time > schedule_end:
+                    today_used_hours += schedule_end - schedule_start
+    return task_time_map, today_used_hours
 
 
 def schedule_task_on_day(
@@ -155,14 +161,17 @@ def schedule_task_on_day(
     today,
     used_hours,
     wait,
+    scheduling_note,
 ):
     # we can schedule task on this day
     employable_hours = task_time_map[day_offset] - used_hours[day_offset]
+    # avoid using too small values
+    employable_hours = 0.01 if 0.01 > employable_hours > 0 else employable_hours
     current_date = today + timedelta(days=day_offset)
     if wait and current_date <= wait:
         if args.verbose:
             print(f"Skipping date {current_date} because of wait date {wait}")
-        return start_date, end_date, task_remaining_hours, is_starting
+        return start_date, end_date, task_remaining_hours, is_starting, scheduling_note
 
     if is_starting:
         if args.verbose:
@@ -170,8 +179,12 @@ def schedule_task_on_day(
         is_starting = False
         start_date = current_date
 
-    if task_remaining_hours <= employable_hours:
+    # minimum value we admit is 0.01 (1 minute)
+    if task_remaining_hours <= employable_hours + 0.01:
         # consume all the remaining task's hours
+        if scheduling_note != "":
+            scheduling_note += "\n"
+        scheduling_note += f"{current_date}: {task_remaining_hours:.2f} hours"
         used_hours[day_offset] += task_remaining_hours
         task_remaining_hours = 0
         end_date = current_date
@@ -180,14 +193,19 @@ def schedule_task_on_day(
             print(f"Used hours on {current_date}: {used_hours[day_offset]}")
     else:
         # consume all the available hours on this task
+        if scheduling_note != "":
+            scheduling_note += "\n"
+        scheduling_note += f"{current_date}: {employable_hours:.2f} hours"
         task_remaining_hours -= employable_hours
         used_hours[day_offset] += employable_hours
         if args.verbose:
             print(f"Working for {employable_hours} hours on task on {current_date}")
-    return start_date, end_date, task_remaining_hours, is_starting
+    return start_date, end_date, task_remaining_hours, is_starting, scheduling_note
 
 
-def mark_end_date(due_date, end_date, start_date, id, description=None):
+def mark_end_date(
+    due_date, end_date, start_date, scheduling_note, id, description=None
+):
     start_end_fields = [f"scheduled:{start_date}", f"completion_date:{end_date}"]
 
     subprocess.run(
@@ -196,6 +214,7 @@ def mark_end_date(due_date, end_date, start_date, id, description=None):
             str(id),
             "modify",
             *start_end_fields,
+            f'scheduling:"{scheduling_note}"',
         ],
         stdout=subprocess.DEVNULL,
         stderr=subprocess.DEVNULL,
@@ -230,7 +249,7 @@ def check_tasks_sequentially(tasks, config):
     time_maps = config["time_maps"]
     today = datetime.today().date()
     todo = [True if t["status"] not in AVOID_STATUS else False for t in tasks]
-    used_hours = [args.today] + [0] * config["scheduler"]["days_ahead"]
+    used_hours = [0] * (config["scheduler"]["days_ahead"] + 1)
     calendars = get_calendars(config)
 
     while any(todo):
@@ -268,33 +287,45 @@ def check_tasks_sequentially(tasks, config):
                 )
 
             task_remaining_hours = estimated_hours
-            task_time_map = get_long_range_time_map(
+            task_time_map, today_used_hours = get_long_range_time_map(
                 time_maps, time_map_names, config["scheduler"]["days_ahead"], calendars
             )
+            used_hours[0] += today_used_hours
 
             # Simulate work day-by-day until task is complete or past due
             is_starting = True
+            scheduling_note = ""
             start_date = end_date = None
             for offset in range(len(task_time_map)):
                 if task_time_map[offset] > used_hours[offset]:
-                    (start_date, end_date, task_remaining_hours, is_starting) = (
-                        schedule_task_on_day(
-                            is_starting,
-                            offset,
-                            start_date,
-                            end_date,
-                            task_remaining_hours,
-                            task_time_map,
-                            today,
-                            used_hours,
-                            wait_date,
-                        )
+                    (
+                        start_date,
+                        end_date,
+                        task_remaining_hours,
+                        is_starting,
+                        scheduling_note,
+                    ) = schedule_task_on_day(
+                        is_starting,
+                        offset,
+                        start_date,
+                        end_date,
+                        task_remaining_hours,
+                        task_time_map,
+                        today,
+                        used_hours,
+                        wait_date,
+                        scheduling_note,
                     )
 
                 if end_date is not None:
                     todo[i] = False
                     mark_end_date(
-                        due_date, end_date, start_date, task["id"], task["description"]
+                        due_date,
+                        end_date,
+                        start_date,
+                        scheduling_note,
+                        task["id"],
+                        task["description"],
                     )
                     break
 

{taskcheck-0.1.2 → taskcheck-0.1.3/taskcheck.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: taskcheck
-Version: 0.1.2
+Version: 0.1.3
 Summary: Automatic scheduler for taskwarrior
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -45,6 +45,8 @@ You can exclude a task from being scheduled by removing the `time_map` or `estim
 
 You can see tasks that you can execute now with the `task ready` report.
 
+You can see the schedule for a task in the `scheduling` UDA.
+
 ## Configuration
 
 1. Create a TOML file at `~/.config/task/taskcheck.toml` with the following format:
@@ -90,6 +92,8 @@ uda.estimated.type = duration
 uda.estimated.label = Estimated Time
 uda.completion_date.type = date
 uda.completion_date.label = Expected Completion Date
+uda.scheduling.type = string
+uda.scheduling.label = Scheduling
 
 # Adjust urgency for taskcheck
 # you will use `wait:` to avoid scheduling tasks too much sooner
@@ -106,7 +110,7 @@ urgency.inherit=1 # use dependencies to automatically prioritize tasks
 urgency.blocking.coefficient=2
 
 # give urgeny values to the estimated time
-# this is ln(estimation)
+# this is log(estimation) + 1, with base so that 36 hours has ~12 urgency
 urgency.uda.estimated.PT1H.coefficient = 1
 urgency.uda.estimated.PT2H.coefficient = 2.32
 urgency.uda.estimated.PT3H.coefficient = 3.67
@@ -152,6 +156,5 @@ urgency.uda.estimated.PT36H.coefficient = 11.96
 ```
 
 -v, --verbose: increase output verbosity
--t, --today: how much time has been already used today (default: 0)
 
 ```