taskcheck 0.2.1__tar.gz → 0.3.0__tar.gz

{taskcheck-0.2.1/taskcheck.egg-info → taskcheck-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: taskcheck
-Version: 0.2.1
+Version: 0.3.0
 Summary: Automatic scheduler for taskwarrior
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -8,6 +8,7 @@ License-File: LICENSE
 Requires-Dist: appdirs>=1.4.4
 Requires-Dist: icalendar>=6.0.1
 Requires-Dist: requests>=2.32.3
+Requires-Dist: rich>=13.9.4
 
 
 > _A non-AI automatic scheduler for taskwarrior (i.e. alternative to skedpal/timehero/flowsavvy/reclaim/trevor/motion)_
@@ -32,13 +33,14 @@ This is a taskwarrior extension checks if tasks can be completed on time, consid
 This extension parses your pending and waiting tasks sorted decreasingly by urgency and tries to schedule them in the future.
 It considers their estimated time to schedule all tasks starting from the most urgent one.
 
+#### UDAs
+
 Taskcheck leverages to UDAs, `estimated` and `time_map`. The `estimated` attribute is
 the expected time to complete the task in hours. The `time_map` is a comma-separated list of strings
 that indicates the hours per day in which you will work on a task (e.g. `work`, `weekend`, etc.).
 The exact correspondence between the `time_map` and the hours of the day is defined in the configuration
 file of taskcheck. For instance:
 
-```toml
 ```toml
 [time_maps]
 # get an error)
@@ -48,6 +50,8 @@ tuesday = [[9, 12.30], [14, 17]]
 # ...
 ```
 
+#### They say it's an "AI"
+
 Taskcheck will also parse online iCal calendars (Google, Apple, etc.) and will match them with your time maps.
 It will then modify the Taskwarrior tasks by adding the `completion_date` attribute with the expected
 date of completion and the `scheduled` attribute with the date in which the task is expected to
@@ -58,6 +62,15 @@ It will also print a red line for every task whose `completion_date` is after it
 In general, it is recommended to run taskcheck rather frequently and at least once at the beginning
 of your working day.
 
+#### Reports
+
+You can also print simple reports that exploit the `scheduling` UDA filled by Taskcheck to grasp
+how much time you have to work on which task in which day. For
+instance:
+
+- `taskcheck -r today` will show the tasks planned for today
+- `taskcheck -r 1w` will show the tasks planned for the next week,
+
 ## Algorithms
 
 Taskcheck provides two scheduling algorithms: `parallel` and `sequential`.
@@ -134,12 +147,11 @@ expiration = 720 # in hours (720 hours = 30 days)
 
 - You can exclude a task from being scheduled by removing the `time_map` or `estimated` attributes.
 - 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, e.g. `task scheduling:$(task calc
-tomorrow)` will show you the tasks that include a scheduling for tomorrow.
 
 ## CLI Options
 
 ```
 -v, --verbose: increase output verbosity
 -i, --install: install taskcheck configuration
+-r, --report: show tasks planned until a certain time
 ```

{taskcheck-0.2.1 → taskcheck-0.3.0}/README.md

@@ -21,13 +21,14 @@ This is a taskwarrior extension checks if tasks can be completed on time, consid
 This extension parses your pending and waiting tasks sorted decreasingly by urgency and tries to schedule them in the future.
 It considers their estimated time to schedule all tasks starting from the most urgent one.
 
+#### UDAs
+
 Taskcheck leverages to UDAs, `estimated` and `time_map`. The `estimated` attribute is
 the expected time to complete the task in hours. The `time_map` is a comma-separated list of strings
 that indicates the hours per day in which you will work on a task (e.g. `work`, `weekend`, etc.).
 The exact correspondence between the `time_map` and the hours of the day is defined in the configuration
 file of taskcheck. For instance:
 
-```toml
 ```toml
 [time_maps]
 # get an error)
@@ -37,6 +38,8 @@ tuesday = [[9, 12.30], [14, 17]]
 # ...
 ```
 
+#### They say it's an "AI"
+
 Taskcheck will also parse online iCal calendars (Google, Apple, etc.) and will match them with your time maps.
 It will then modify the Taskwarrior tasks by adding the `completion_date` attribute with the expected
 date of completion and the `scheduled` attribute with the date in which the task is expected to
@@ -47,6 +50,15 @@ It will also print a red line for every task whose `completion_date` is after it
 In general, it is recommended to run taskcheck rather frequently and at least once at the beginning
 of your working day.
 
+#### Reports
+
+You can also print simple reports that exploit the `scheduling` UDA filled by Taskcheck to grasp
+how much time you have to work on which task in which day. For
+instance:
+
+- `taskcheck -r today` will show the tasks planned for today
+- `taskcheck -r 1w` will show the tasks planned for the next week,
+
 ## Algorithms
 
 Taskcheck provides two scheduling algorithms: `parallel` and `sequential`.
@@ -123,12 +135,11 @@ expiration = 720 # in hours (720 hours = 30 days)
 
 - You can exclude a task from being scheduled by removing the `time_map` or `estimated` attributes.
 - 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, e.g. `task scheduling:$(task calc
-tomorrow)` will show you the tasks that include a scheduling for tomorrow.
 
 ## CLI Options
 
 ```
 -v, --verbose: increase output verbosity
 -i, --install: install taskcheck configuration
+-r, --report: show tasks planned until a certain time
 ```

{taskcheck-0.2.1 → taskcheck-0.3.0}/pyproject.toml

@@ -1,10 +1,15 @@
 [project]
 name = "taskcheck"
-version = "0.2.1"
+version = "0.3.0"
 description = "Automatic scheduler for taskwarrior"
 readme = "README.md"
 requires-python = ">=3.11"
-dependencies = ["appdirs>=1.4.4", "icalendar>=6.0.1", "requests>=2.32.3"]
+dependencies = [
+  "appdirs>=1.4.4",
+  "icalendar>=6.0.1",
+  "requests>=2.32.3",
+  "rich>=13.9.4",
+]
 
 [project.scripts]
 taskcheck = "taskcheck.__main__:main"

{taskcheck-0.2.1 → taskcheck-0.3.0}/taskcheck/__main__.py

@@ -7,13 +7,19 @@ from taskcheck.common import config_dir
 
 arg_parser = argparse.ArgumentParser()
 arg_parser.add_argument(
-    "-v", "--verbose", action="store_true", help="increase output verbosity"
+    "-v", "--verbose", action="store_true", help="increase output verbosity."
 )
 arg_parser.add_argument(
     "-i",
     "--install",
     action="store_true",
-    help="install the UDAs, required settings, and default config file",
+    help="install the UDAs, required settings, and default config file.",
+)
+arg_parser.add_argument(
+    "-r",
+    "--report",
+    action="store",
+    help="generate a report of the tasks based on the scheduling; can be any Taskwarrior datetime specification (e.g. today, tomorrow, eom, som, 1st, 2nd, etc.). It is considered as `by`, meaning that the report will be generated for all the days until the specified date and including it.",
 )
 
 args = arg_parser.parse_args()
@@ -34,6 +40,13 @@ def main():
         install()
         return
 
+    if args.report:
+        from taskcheck.report import generate_report
+
+        config = load_config()
+        generate_report(config, args.report, args.verbose)
+        return
+
     config = load_config()
     algo = config["scheduler"].get("algorithm", "parallel")
     if algo == "parallel":

{taskcheck-0.2.1 → taskcheck-0.3.0}/taskcheck/common.py

@@ -91,19 +91,36 @@ def pdth_to_hours(duration_str):
     # string format is P#DT#H
     # with D and H optional
     duration_str = duration_str[1:]  # Remove leading "P"
-    days, hours = 0, 0
+    days, hours, minutes = 0, 0, 0
     if "D" in duration_str:
         days, duration_str = duration_str.split("D")
         days = int(days)
     if "H" in duration_str:
         hours = int(duration_str.split("T")[1].split("H")[0])
-    return days * 24 + hours
+    if "M" in duration_str:
+        minutes = int(duration_str.split("H")[1].split("M")[0])
+    return days * 24 + hours + minutes / 60
 
 
 def hours_to_pdth(hours):
-    days = hours // 24
-    hours = hours % 24
-    return f"P{days}DT{hours}H"
+    days_ = hours / 24
+    hours_ = hours % 24
+    minutes_ = int(round((hours_ - int(hours_)) * 60))
+    days_ = int(days_)
+    hours_ = int(hours_)
+    minutes_ = int(minutes_)
+    ret = "P"
+    if days_ == 0:
+        ret += "T"
+    else:
+        ret += f"{days_}DT"
+    if hours_ > 0:
+        ret += f"{hours_}H"
+    if minutes_ > 0:
+        ret += f"{minutes_}M"
+    if ret == "PT":
+        print("Warning: hours_to_pdth() returned 'PT' for hours = ", hours)
+    return ret
 
 
 def get_long_range_time_map(

{taskcheck-0.2.1 → taskcheck-0.3.0}/taskcheck/parallel.py

@@ -57,12 +57,10 @@ def compute_estimated_urgency(remaining_hours, urgency_coefficients):
     """
     Computes the estimated urgency for the given remaining hours using the coefficients.
     """
-    # Convert remaining hours to PDTH format used in the coefficients
-    pdth_value = hours_to_pdth(remaining_hours)
     # Find the closest match (e.g., if '2h' is not available, use '1h' or '3h')
     closest_match = min(
         urgency_coefficients.estimated.keys(),
-        key=lambda x: abs(int(pdth_value[1]) - int(pdth_to_hours(x[1]))),
+        key=lambda x: abs(pdth_to_hours(x) - remaining_hours),
     )
     coefficient = urgency_coefficients.estimated[closest_match]
     # Compute the urgency
@@ -246,7 +244,7 @@ def allocate_time_to_task(info, day_offset, day_remaining_hours):
         hours_to_decimal(info["task"].get("min_block", 2)),
     )
 
-    if allocation <= 0:
+    if allocation <= 0.05:
         return 0
 
     info["remaining_hours"] -= allocation
@@ -273,7 +271,7 @@ def update_tasks_with_scheduling_info(task_info, verbose):
         end_date = scheduled_dates[-1]
         for date_str in scheduled_dates:
             hours = info["scheduling"][date_str]
-            scheduling_note += f"{date_str}T00:00:00 - {hours:.2f} hours\n"
+            scheduling_note += f"{date_str} - {hours_to_pdth(hours)}\n"
 
         subprocess.run(
             [

taskcheck-0.3.0/taskcheck/report.py

@@ -0,0 +1,122 @@
+import sys
+from datetime import timedelta
+from datetime import datetime
+import json
+import re
+import subprocess
+
+
+from rich import print
+from rich.console import Console
+from rich.table import Table
+from rich.text import Text
+from rich.panel import Panel
+
+
+def get_tasks(tasks, year, month, day):
+    regex = re.compile(rf"{year}-{month}-{day} - ([PDTHM0-9]+)")
+    valid_tasks = []
+    for task in tasks:
+        for line in task["scheduling"].split("\n"):
+            m = regex.match(line)
+            if m:
+                due = task.get("due", "")
+                if due:
+                    due = datetime.strptime(due, "%Y%m%dT%H%M%SZ")
+                    due = due - datetime.today()
+                valid_tasks.append(
+                    {
+                        "id": task["id"],
+                        "project": task.get("project", ""),
+                        "description": task["description"],
+                        "scheduling_day": f"{year}-{month}-{day}",
+                        "scheduling_hours": m.group(1),
+                        "urgency": task["urgency"],
+                        "due": due,
+                    }
+                )
+    valid_tasks = sorted(valid_tasks, key=lambda x: x["urgency"], reverse=True)
+    return valid_tasks
+
+
+def get_taskwarrior_date(date, _retry=True):
+    date = subprocess.run(
+        ["task", "calc", date],
+        capture_output=True,
+        text=True,
+    )
+    date = date.stdout.strip()
+    try:
+        date = datetime.strptime(date, "%Y-%m-%dT%H:%M:%S")
+    except Exception as _:
+        if _retry:
+            return get_taskwarrior_date("today+" + date, False)
+        else:
+            print(
+                "Please provide a valid date. Check with `task calc` that your date is in the format YYYY-MM-DDTHH:MM:SS",
+                file=sys.stderr,
+            )
+            exit(2)
+    return date
+
+
+def get_days_in_constraint(constraint):
+    current_date = datetime.today().replace(hour=0, minute=0, second=0, microsecond=0)
+    constraint = get_taskwarrior_date(constraint)
+    while current_date <= constraint:
+        yield current_date.year, current_date.month, current_date.day
+        current_date += timedelta(days=1)
+
+
+def generate_report(config, constraint, verbose=False):
+    console = Console()
+    tasks = subprocess.run(
+        ["task", "scheduling~.", "export"], capture_output=True, text=True
+    )
+    tasks = json.loads(tasks.stdout)
+
+    for year, month, day in get_days_in_constraint(constraint):
+        this_day_tasks = get_tasks(tasks, year, month, day)
+
+        # Create a colorful date header with emojis and a panel
+        date_str = f":calendar: [bold cyan]{year}-{month}-{day}[/bold cyan]"
+        console.print(Panel(date_str, style="bold magenta", expand=False))
+
+        if this_day_tasks:
+            table = Table(show_header=True, header_style="bold blue")
+            table.add_column("Task", style="dim", width=12)
+            table.add_column("Project", style="dim", width=12)
+            table.add_column("Description")
+            table.add_column("Time", justify="right")
+            table.add_column("Urgency")
+            table.add_column("Due date")
+
+            for task in this_day_tasks:
+                task_id = f"[bold green]#{task['id']}[/bold green]"
+                project = task["project"]
+                description = Text(task["description"], style="white")
+                hours = f"[yellow]{task['scheduling_hours']}h[/yellow]"
+                urgency = f"[bold]{task['urgency']}[/bold]"
+                due = task["due"]
+                if due != "" and due < timedelta(days=5):
+                    due = f"[red]{due.days}d[/red]"
+                elif due != "":
+                    due = f"[green]{due.days}d[/green]"
+
+                # Add an emoji based on a keyword in the description
+                if "meeting" in task["description"].lower():
+                    emoji = ":busts_in_silhouette:"
+                elif "review" in task["description"].lower():
+                    emoji = ":mag_right:"
+                elif "write" in task["description"].lower():
+                    emoji = ":pencil:"
+                else:
+                    emoji = ":pushpin:"
+
+                table.add_row(
+                    f"{emoji} {task_id}", project, description, hours, urgency, due
+                )
+
+            console.print(table)
+        else:
+            console.print("[italic dim]No tasks scheduled for this day.[/italic dim]")

{taskcheck-0.2.1 → taskcheck-0.3.0}/taskcheck/sequential.py

@@ -5,6 +5,7 @@ from taskcheck.common import (
     get_tasks,
     mark_end_date,
     pdth_to_hours,
+    hours_to_pdth,
     AVOID_STATUS,
 )
 
@@ -43,7 +44,7 @@ def schedule_task_on_day(
         # consume all the remaining task's hours
         if scheduling_note != "":
             scheduling_note += "\n"
-        scheduling_note += f"{current_date}: {task_remaining_hours:.2f} hours"
+        scheduling_note += f"{current_date} - {hours_to_pdth(task_remaining_hours)}\n"
         used_hours[day_offset] += task_remaining_hours
         task_remaining_hours = 0
         end_date = current_date
@@ -54,7 +55,7 @@ def schedule_task_on_day(
         # consume all the available hours on this task
         if scheduling_note != "":
             scheduling_note += "\n"
-        scheduling_note += f"{current_date}T00:00:00 - {employable_hours:.2f} hours"
+        scheduling_note += f"{current_date} - {hours_to_pdth(employable_hours)}\n"
         task_remaining_hours -= employable_hours
         used_hours[day_offset] += employable_hours
         if verbose:

{taskcheck-0.2.1 → taskcheck-0.3.0/taskcheck.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: taskcheck
-Version: 0.2.1
+Version: 0.3.0
 Summary: Automatic scheduler for taskwarrior
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -8,6 +8,7 @@ License-File: LICENSE
 Requires-Dist: appdirs>=1.4.4
 Requires-Dist: icalendar>=6.0.1
 Requires-Dist: requests>=2.32.3
+Requires-Dist: rich>=13.9.4
 
 
 > _A non-AI automatic scheduler for taskwarrior (i.e. alternative to skedpal/timehero/flowsavvy/reclaim/trevor/motion)_
@@ -32,13 +33,14 @@ This is a taskwarrior extension checks if tasks can be completed on time, consid
 This extension parses your pending and waiting tasks sorted decreasingly by urgency and tries to schedule them in the future.
 It considers their estimated time to schedule all tasks starting from the most urgent one.
 
+#### UDAs
+
 Taskcheck leverages to UDAs, `estimated` and `time_map`. The `estimated` attribute is
 the expected time to complete the task in hours. The `time_map` is a comma-separated list of strings
 that indicates the hours per day in which you will work on a task (e.g. `work`, `weekend`, etc.).
 The exact correspondence between the `time_map` and the hours of the day is defined in the configuration
 file of taskcheck. For instance:
 
-```toml
 ```toml
 [time_maps]
 # get an error)
@@ -48,6 +50,8 @@ tuesday = [[9, 12.30], [14, 17]]
 # ...
 ```
 
+#### They say it's an "AI"
+
 Taskcheck will also parse online iCal calendars (Google, Apple, etc.) and will match them with your time maps.
 It will then modify the Taskwarrior tasks by adding the `completion_date` attribute with the expected
 date of completion and the `scheduled` attribute with the date in which the task is expected to
@@ -58,6 +62,15 @@ It will also print a red line for every task whose `completion_date` is after it
 In general, it is recommended to run taskcheck rather frequently and at least once at the beginning
 of your working day.
 
+#### Reports
+
+You can also print simple reports that exploit the `scheduling` UDA filled by Taskcheck to grasp
+how much time you have to work on which task in which day. For
+instance:
+
+- `taskcheck -r today` will show the tasks planned for today
+- `taskcheck -r 1w` will show the tasks planned for the next week,
+
 ## Algorithms
 
 Taskcheck provides two scheduling algorithms: `parallel` and `sequential`.
@@ -134,12 +147,11 @@ expiration = 720 # in hours (720 hours = 30 days)
 
 - You can exclude a task from being scheduled by removing the `time_map` or `estimated` attributes.
 - 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, e.g. `task scheduling:$(task calc
-tomorrow)` will show you the tasks that include a scheduling for tomorrow.
 
 ## CLI Options
 
 ```
 -v, --verbose: increase output verbosity
 -i, --install: install taskcheck configuration
+-r, --report: show tasks planned until a certain time
 ```

{taskcheck-0.2.1 → taskcheck-0.3.0}/taskcheck.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ taskcheck/common.py
 taskcheck/ical.py
 taskcheck/install.py
 taskcheck/parallel.py
+taskcheck/report.py
 taskcheck/sequential.py
 taskcheck.egg-info/PKG-INFO
 taskcheck.egg-info/SOURCES.txt

{taskcheck-0.2.1 → taskcheck-0.3.0}/taskcheck.egg-info/requires.txt

@@ -1,3 +1,4 @@
 appdirs>=1.4.4
 icalendar>=6.0.1
 requests>=2.32.3
+rich>=13.9.4