taskcheck 0.3.0.post1__tar.gz → 0.3.2__tar.gz

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

@@ -1,12 +1,13 @@
 Metadata-Version: 2.1
 Name: taskcheck
-Version: 0.3.0.post1
+Version: 0.3.2
 Summary: Automatic scheduler for taskwarrior
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: appdirs>=1.4.4
 Requires-Dist: icalendar>=6.0.1
+Requires-Dist: random-unicode-emoji>=2.8
 Requires-Dist: requests>=2.32.3
 Requires-Dist: rich>=13.9.4
 
@@ -15,6 +16,10 @@ Requires-Dist: rich>=13.9.4
 
 This is a taskwarrior extension checks if tasks can be completed on time, considering estimated time and working hours.
 
+<p align="center">
+<img src="https://github.com/user-attachments/assets/b9082701-339b-4407-b941-b613a717382c"/>
+</p>
+
 ## Features
 
 - [x] Use arbitrarily complex time maps
@@ -71,29 +76,9 @@ 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`.
-
-#### Sequential
-
-The `sequential` algorithm schedules tasks one after the other. It is the simplest algorithm.
-It looks at your tasks one by one, computes the time slots available for that task, and fills them
-as soon as possible.
-
-While it sounds logical, it has a problem.
-While you're working on a task, its remaining estimated time is decreasing, and if your urgency
-depends on the estimated time left, the urgency of the task will decrease as well.
-This is especially problematic for long tasks: imagine if you block your whole week for a single
-task and all the other small tasks, even if urgent, don't get scheduled. After a few days, the
-urgency of the first long task should have decreased.
+## Algorithm
 
-#### Parallel
-
-The `parallel` algorithm tries to solve the problem of the `sequential` algorithm.
-
-Instead of allocating all the available time for a task until the task is finished, the `parallel`
-algorithm allocates a fixed amount of time for each task (e.g. 1 hour) and then recomputes the
+The algorithm allocates a fixed amount of time for each task (e.g. 1 hour) and then recomputes the
 urgency and restart the allocation procedure.
 
 If after 1 hour the long task has decreased urgency, that will be noticed and the newer most urgent
@@ -102,8 +87,6 @@ task will get scheduled in its place.
 The minimum time for a task is by default 2 hours, but you can change it by tuning the `min_block`
 taskwarrior UDA.
 
-The `parallel` algorithm is the default algorithm.
-
 ## Configuration
 
 `taskcheck --install` allows you to create required and recommended configurations for
@@ -127,7 +110,6 @@ saturday = [[9, 12.30], ]
 sunday = [[9, 12.30], ]
 
 [scheduler]
-algorithm = "parallel" # or "sequential", see above
 days_ahead = 1000 # how far go with the schedule (lower values make the computation faster)
 
 [calendars]
@@ -141,6 +123,13 @@ timezone = "Europe/Rome" # if set, force timezone for this calendar; timezone va
 url = "https://www.officeholidays.com/ics-clean/italy/milan"
 event_all_day_is_blocking = true
 expiration = 720 # in hours (720 hours = 30 days)
+
+[report]
+additional_attributes = ["estimated", "due", "urgency"] # additional attributes to show in the report
+# when these words are matched in the task description, the corresponding emoji is used
+emoji_keywords = {"meet"=":busts_in_silhouette:", "review"=":mag_right:"}
+include_unplanned = true # include unplanned tasks in the report in an ad-hoc section
+additional_attributes_unplanned = ["due", "urgency"] # additional attributes to show in the report for unplanned tasks
 ```
 
 ## Tips and Tricks

{taskcheck-0.3.0.post1 → taskcheck-0.3.2}/README.md

@@ -3,6 +3,10 @@
 
 This is a taskwarrior extension checks if tasks can be completed on time, considering estimated time and working hours.
 
+<p align="center">
+<img src="https://github.com/user-attachments/assets/b9082701-339b-4407-b941-b613a717382c"/>
+</p>
+
 ## Features
 
 - [x] Use arbitrarily complex time maps
@@ -59,29 +63,9 @@ 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`.
-
-#### Sequential
-
-The `sequential` algorithm schedules tasks one after the other. It is the simplest algorithm.
-It looks at your tasks one by one, computes the time slots available for that task, and fills them
-as soon as possible.
-
-While it sounds logical, it has a problem.
-While you're working on a task, its remaining estimated time is decreasing, and if your urgency
-depends on the estimated time left, the urgency of the task will decrease as well.
-This is especially problematic for long tasks: imagine if you block your whole week for a single
-task and all the other small tasks, even if urgent, don't get scheduled. After a few days, the
-urgency of the first long task should have decreased.
+## Algorithm
 
-#### Parallel
-
-The `parallel` algorithm tries to solve the problem of the `sequential` algorithm.
-
-Instead of allocating all the available time for a task until the task is finished, the `parallel`
-algorithm allocates a fixed amount of time for each task (e.g. 1 hour) and then recomputes the
+The algorithm allocates a fixed amount of time for each task (e.g. 1 hour) and then recomputes the
 urgency and restart the allocation procedure.
 
 If after 1 hour the long task has decreased urgency, that will be noticed and the newer most urgent
@@ -90,8 +74,6 @@ task will get scheduled in its place.
 The minimum time for a task is by default 2 hours, but you can change it by tuning the `min_block`
 taskwarrior UDA.
 
-The `parallel` algorithm is the default algorithm.
-
 ## Configuration
 
 `taskcheck --install` allows you to create required and recommended configurations for
@@ -115,7 +97,6 @@ saturday = [[9, 12.30], ]
 sunday = [[9, 12.30], ]
 
 [scheduler]
-algorithm = "parallel" # or "sequential", see above
 days_ahead = 1000 # how far go with the schedule (lower values make the computation faster)
 
 [calendars]
@@ -129,6 +110,13 @@ timezone = "Europe/Rome" # if set, force timezone for this calendar; timezone va
 url = "https://www.officeholidays.com/ics-clean/italy/milan"
 event_all_day_is_blocking = true
 expiration = 720 # in hours (720 hours = 30 days)
+
+[report]
+additional_attributes = ["estimated", "due", "urgency"] # additional attributes to show in the report
+# when these words are matched in the task description, the corresponding emoji is used
+emoji_keywords = {"meet"=":busts_in_silhouette:", "review"=":mag_right:"}
+include_unplanned = true # include unplanned tasks in the report in an ad-hoc section
+additional_attributes_unplanned = ["due", "urgency"] # additional attributes to show in the report for unplanned tasks
 ```
 
 ## Tips and Tricks

{taskcheck-0.3.0.post1 → taskcheck-0.3.2}/pyproject.toml

@@ -1,12 +1,13 @@
 [project]
 name = "taskcheck"
-version = "0.3.0-1"
+version = "0.3.2"
 description = "Automatic scheduler for taskwarrior"
 readme = "README.md"
 requires-python = ">=3.11"
 dependencies = [
   "appdirs>=1.4.4",
   "icalendar>=6.0.1",
+  "random-unicode-emoji>=2.8",
   "requests>=2.32.3",
   "rich>=13.9.4",
 ]

{taskcheck-0.3.0.post1 → taskcheck-0.3.2}/taskcheck/__main__.py

@@ -48,13 +48,7 @@ def main():
         return
 
     config = load_config()
-    algo = config["scheduler"].get("algorithm", "parallel")
-    if algo == "parallel":
-        check_tasks_parallel(config, verbose=args.verbose)
-    elif algo == "sequential":
-        check_tasks_sequentially(config, verbose=args.verbose)
-    else:
-        raise ValueError(f"Unknown algorithm: {algo}")
+    check_tasks_parallel(config, verbose=args.verbose)
 
 
 if __name__ == "__main__":

{taskcheck-0.3.0.post1 → taskcheck-0.3.2}/taskcheck/common.py

@@ -101,7 +101,10 @@ def pdth_to_hours(duration_str):
     if "H" in duration_str:
         hours = int(duration_str.split("T")[1].split("H")[0])
     if "M" in duration_str:
-        minutes = int(duration_str.split("H")[1].split("M")[0])
+        if "H" in duration_str:
+            minutes = int(duration_str.split("H")[1].split("M")[0])
+        else:
+            minutes = int(duration_str.split("T")[1].split("M")[0])
     return days * 24 + hours + minutes / 60
 
 
@@ -155,6 +158,8 @@ def get_long_range_time_map(
         time_map = time_maps[time_map_name].get(today_weekday)
         if time_map:
             for schedule_start, schedule_end in time_map:
+                schedule_start = hours_to_decimal(schedule_start)
+                schedule_end = hours_to_decimal(schedule_end)
                 if schedule_start <= today_time <= schedule_end:
                     today_used_hours += today_time - schedule_start
                     break

{taskcheck-0.3.0.post1 → taskcheck-0.3.2}/taskcheck/install.py

@@ -12,7 +12,6 @@ thursday = [[9, 12.30], [14, 17]]
 friday = [[9, 12.30], [14, 17]]
 
 [scheduler]
-algorithm = "parallel"
 days_ahead = 365
 """
 

taskcheck-0.3.2/taskcheck/report.py

@@ -0,0 +1,397 @@
+import random
+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
+
+from random_unicode_emoji import random_emoji
+
+
+DEFAULT_EMOJI_KEYWORDS = {
+    "meet": ":busts_in_silhouette:",
+    "incontr": ":busts_in_silhouette:",
+    "rencontr": ":busts_in_silhouette:",
+    "reun": ":busts_in_silhouette:",
+    "treff": ":busts_in_silhouette:",
+    "review": ":mag_right:",
+    "revis": ":mag_right:",
+    "révis": ":mag_right:",
+    "überprüf": ":mag_right:",
+    "write": ":pencil2:",
+    "scriv": ":pencil2:",
+    "écri": ":pencil2:",
+    "escrib": ":pencil2:",
+    "schreib": ":pencil2:",
+    "read": ":books:",
+    "legg": ":books:",
+    "lis": ":books:",
+    "le": ":books:",
+    "les": ":books:",
+    "posta": ":email:",
+    "courri": ":email:",
+    "corre": ":email:",
+    "mail": ":email:",
+    "call": ":telephone_receiver:",
+    "chiam": ":telephone_receiver:",
+    "appel": ":telephone_receiver:",
+    "llam": ":telephone_receiver:",
+    "ruf": ":telephone_receiver:",
+    "présent": ":chart_with_upwards_trend:",
+    "present": ":chart_with_upwards_trend:",
+    "präsent": ":chart_with_upwards_trend:",
+    "learn": ":mortar_board:",
+    "impar": ":mortar_board:",
+    "appren": ":mortar_board:",
+    "aprend": ":mortar_board:",
+    "lern": ":mortar_board:",
+    "search": ":mag:",
+    "cerc": ":mag:",
+    "cherch": ":mag:",
+    "busc": ":mag:",
+    "such": ":mag:",
+    "idea": ":bulb:",
+    "idé": ":bulb:",
+    "ide": ":bulb:",
+    "break": ":coffee:",
+    "paus": ":coffee:",
+    "descans": ":coffee:",
+    "lunch": ":fork_and_knife:",
+    "pranz": ":fork_and_knife:",
+    "déjeun": ":fork_and_knife:",
+    "almorz": ":fork_and_knife:",
+    "mittag": ":fork_and_knife:",
+    "test": ":test_tube:",
+    "develop": ":hammer_and_wrench:",
+    "svilupp": ":hammer_and_wrench:",
+    "développ": ":hammer_and_wrench:",
+    "desarroll": ":hammer_and_wrench:",
+    "entwickl": ":hammer_and_wrench:",
+    "disegn": ":art:",
+    "diseñ": ":art:",
+    "design": ":art:",
+    "dafar": ":memo:",
+    "tarea": ":memo:",
+    "todo": ":memo:",
+    "bug": ":beetle:",
+    "käfer": ":beetle:",
+    "fix": ":wrench:",
+    "corregg": ":wrench:",
+    "répar": ":wrench:",
+    "beheb": ":wrench:",
+    "urgent": ":exclamation:",
+    "dringend": ":exclamation:",
+    "deadlin": ":hourglass_flowing_sand:",
+    "scadenz": ":hourglass_flowing_sand:",
+    "délais": ":hourglass_flowing_sand:",
+    "fechalim": ":hourglass_flowing_sand:",
+    "frist": ":hourglass_flowing_sand:",
+    "updat": ":arrows_counterclockwise:",
+    "aggiorn": ":arrows_counterclockwise:",
+    "mett": ":arrows_counterclockwise:",
+    "actualiz": ":arrows_counterclockwise:",
+    "aktualisier": ":arrows_counterclockwise:",
+    "clean": ":broom:",
+    "pul": ":broom:",
+    "nettoy": ":broom:",
+    "limpi": ":broom:",
+    "reinig": ":broom:",
+    "deploy": ":rocket:",
+    "rilasc": ":rocket:",
+    "déploy": ":rocket:",
+    "despleg": ":rocket:",
+    "bereitstell": ":rocket:",
+    "festegg": ":tada:",
+    "célébr": ":tada:",
+    "celebr": ":tada:",
+    "feier": ":tada:",
+    "research": ":microscope:",
+    "ricerc": ":microscope:",
+    "recherch": ":microscope:",
+    "investig": ":microscope:",
+    "forsch": ":microscope:",
+    "shop": ":shopping_cart:",
+    "achet": ":shopping_cart:",
+    "compr": ":shopping_cart:",
+    "einkauf": ":shopping_cart:",
+    "social": ":handshake:",
+    "sozial": ":handshake:",
+    "exercis": ":running_shoe:",
+    "eserciz": ":running_shoe:",
+    "exercic": ":running_shoe:",
+    "ejerc": ":running_shoe:",
+    "übun": ":running_shoe:",
+    "évènement": ":calendar:",
+    "event": ":calendar:",
+    "movie": ":clapper:",
+    "pelicul": ":clapper:",
+    "film": ":clapper:",
+    "music": ":musical_note:",
+    "musik": ":musical_note:",
+    "travel": ":airplane:",
+    "viagg": ":airplane:",
+    "voyag": ":airplane:",
+    "viaj": ":airplane:",
+    "reis": ":airplane:",
+    "home": ":house:",
+    "mais": ":house:",
+    "cas": ":house:",
+    "haus": ":house:",
+    "docu": ":notebook:",
+    "dokum": ":notebook:",
+    "backup": ":floppy_disk:",
+    "salvat": ":floppy_disk:",
+    "sauveg": ":floppy_disk:",
+    "copiaseg": ":floppy_disk:",
+    "sicher": ":floppy_disk:",
+    "debug": ":bug:",
+    "débug": ":bug:",
+    "note": ":spiral_notepad:",
+    "not": ":spiral_notepad:",
+    "focus": ":dart:",
+    "concentr": ":dart:",
+    "konzentrier": ":dart:",
+    "codic": ":computer:",
+    "cod": ":computer:",
+    "code": ":computer:",
+    "serveur": ":cloud:",
+    "servidor": ":cloud:",
+    "server": ":cloud:",
+    "client": ":briefcase:",
+    "priorid": ":bangbang:",
+    "priorit": ":bangbang:",
+    "star": ":star:",
+    "stell": ":star:",
+    "étoil": ":star:",
+    "estrell": ":star:",
+    "stern": ":star:",
+    "critic": ":fire:",
+    "kritisch": ":fire:",
+}
+
+
+def get_tasks(config, 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),
+                        **{
+                            attr: task.get(attr, "")
+                            for attr in config.get("additional_attributes", [])
+                        },
+                    }
+                )
+    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 tostring(value):
+    if isinstance(value, bool):
+        return "Yes" if value else "No"
+    elif isinstance(value, datetime):
+        return value.strftime("%Y-%m-%d %H:%M")
+    elif isinstance(value, str):
+        try:
+            date = datetime.strptime(value, "%Y%m%dT%H%M%SZ")
+            return date.strftime("%Y-%m-%d %H:%M")
+        except ValueError:
+            return value
+    else:
+        return str(value)
+
+
+def get_unplanned_tasks(config, tasks):
+    tasks = subprocess.run(
+        ["task", "scheduling:", "status:pending", "export"],
+        capture_output=True,
+        text=True,
+    )
+    tasks = json.loads(tasks.stdout)
+    return tasks
+
+
+def generate_report(config, constraint, verbose=False):
+    config = config["report"]
+    console = Console()
+    tasks = fetch_tasks()
+
+    for year, month, day in get_days_in_constraint(constraint):
+        this_day_tasks = get_tasks(config, tasks, year, month, day)
+
+        display_date_header(console, year, month, day)
+
+        display_tasks_table(console, config, this_day_tasks)
+
+    if config.get("include_unplanned"):
+        unplanned_tasks = get_unplanned_tasks(config, tasks)
+        display_unplanned_tasks(console, config, unplanned_tasks)
+
+
+def fetch_tasks():
+    """Fetch tasks from the task manager and return them as a JSON object."""
+    tasks = subprocess.run(
+        ["task", "scheduling~.", "(", "+PENDING", "or", "+WAITING", ")", "export"],
+        capture_output=True,
+        text=True,
+    )
+    return json.loads(tasks.stdout)
+
+
+def display_date_header(console, year, month, day):
+    """Display a date header with a calendar emoji."""
+    date_str = f":calendar: [bold cyan]{year}-{month}-{day}[/bold cyan]"
+    console.print(Panel(date_str, style="bold blue", expand=False))
+
+
+def display_tasks_table(console, config, tasks):
+    """Display a table of tasks for a specific day."""
+    if tasks:
+        table = build_tasks_table(config, tasks)
+        console.print(table)
+    else:
+        console.print("[italic dim]No tasks scheduled for this day.[/italic dim]")
+
+
+def build_tasks_table(config, tasks):
+    """Build a Rich table for displaying 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")
+    for attr in config.get("additional_attributes", []):
+        table.add_column(attr.capitalize(), justify="right")
+
+    for task in tasks:
+        task_id = f"[bold green]#{task['id']}[/bold green]"
+        project = task.get("project", "")
+        description = Text(task["description"], style="white")
+        hours = f"[yellow]{task['scheduling_hours']}[/yellow]"
+        emoji = get_task_emoji(config, task)
+
+        table.add_row(
+            f"{emoji} {task_id}",
+            project,
+            description,
+            hours,
+            *[
+                tostring(task.get(attr, ""))
+                for attr in config.get("additional_attributes", [])
+            ],
+        )
+    return table
+
+
+def get_task_emoji(config, task):
+    """Get an emoji based on keywords in the task description."""
+    for keyword in config.get("emoji_keywords", []):
+        if keyword in task["description"].lower():
+            return config["emoji_keywords"][keyword]
+    for keyword, emoji in DEFAULT_EMOJI_KEYWORDS.items():
+        if keyword in task["description"].lower():
+            return emoji
+    # sum the unicode numbers of each letter in the description and use it as seed to get a random unicode
+    # emoji
+    seed = sum(ord(char) for char in task["description"])
+    emoji = ""
+    # seed the next call to random.choice
+    random.seed(seed)
+    emoji = random_emoji()[0]
+    # some emoji coutn for more than one character and misbehave the tables of rich
+    if len(emoji) > 1:
+        while len(emoji) != 1:
+            emoji = random_emoji()[0]
+    return emoji
+
+
+def display_unplanned_tasks(console, config, tasks):
+    """Display unplanned tasks if any are found."""
+    if tasks:
+        table = build_unplanned_tasks_table(config, tasks)
+        console.print(Panel("Unplanned Tasks", style="bold blue", expand=False))
+        console.print(table)
+    else:
+        console.print(
+            Panel(
+                "[italic dim]No unplanned tasks found.[/italic dim]",
+                style="bold blue",
+                expand=False,
+            )
+        )
+
+
+def build_unplanned_tasks_table(config, tasks):
+    """Build a Rich table for displaying unplanned 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")
+    for attr in config.get("additional_attributes_unplanned", []):
+        table.add_column(attr.capitalize(), justify="right")
+
+    for task in tasks:
+        task_id = f"[bold green]#{task['id']}[/bold green]"
+        project = task.get("project", "")
+        description = Text(task["description"], style="white")
+        emoji = get_task_emoji(config, task)
+
+        table.add_row(
+            f"{emoji} {task_id}",
+            project,
+            description,
+            *[
+                tostring(task.get(attr, ""))
+                for attr in config.get("additional_attributes_unplanned", [])
+            ],
+        )
+    return table

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

@@ -1,12 +1,13 @@
 Metadata-Version: 2.1
 Name: taskcheck
-Version: 0.3.0.post1
+Version: 0.3.2
 Summary: Automatic scheduler for taskwarrior
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: appdirs>=1.4.4
 Requires-Dist: icalendar>=6.0.1
+Requires-Dist: random-unicode-emoji>=2.8
 Requires-Dist: requests>=2.32.3
 Requires-Dist: rich>=13.9.4
 
@@ -15,6 +16,10 @@ Requires-Dist: rich>=13.9.4
 
 This is a taskwarrior extension checks if tasks can be completed on time, considering estimated time and working hours.
 
+<p align="center">
+<img src="https://github.com/user-attachments/assets/b9082701-339b-4407-b941-b613a717382c"/>
+</p>
+
 ## Features
 
 - [x] Use arbitrarily complex time maps
@@ -71,29 +76,9 @@ 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`.
-
-#### Sequential
-
-The `sequential` algorithm schedules tasks one after the other. It is the simplest algorithm.
-It looks at your tasks one by one, computes the time slots available for that task, and fills them
-as soon as possible.
-
-While it sounds logical, it has a problem.
-While you're working on a task, its remaining estimated time is decreasing, and if your urgency
-depends on the estimated time left, the urgency of the task will decrease as well.
-This is especially problematic for long tasks: imagine if you block your whole week for a single
-task and all the other small tasks, even if urgent, don't get scheduled. After a few days, the
-urgency of the first long task should have decreased.
+## Algorithm
 
-#### Parallel
-
-The `parallel` algorithm tries to solve the problem of the `sequential` algorithm.
-
-Instead of allocating all the available time for a task until the task is finished, the `parallel`
-algorithm allocates a fixed amount of time for each task (e.g. 1 hour) and then recomputes the
+The algorithm allocates a fixed amount of time for each task (e.g. 1 hour) and then recomputes the
 urgency and restart the allocation procedure.
 
 If after 1 hour the long task has decreased urgency, that will be noticed and the newer most urgent
@@ -102,8 +87,6 @@ task will get scheduled in its place.
 The minimum time for a task is by default 2 hours, but you can change it by tuning the `min_block`
 taskwarrior UDA.
 
-The `parallel` algorithm is the default algorithm.
-
 ## Configuration
 
 `taskcheck --install` allows you to create required and recommended configurations for
@@ -127,7 +110,6 @@ saturday = [[9, 12.30], ]
 sunday = [[9, 12.30], ]
 
 [scheduler]
-algorithm = "parallel" # or "sequential", see above
 days_ahead = 1000 # how far go with the schedule (lower values make the computation faster)
 
 [calendars]
@@ -141,6 +123,13 @@ timezone = "Europe/Rome" # if set, force timezone for this calendar; timezone va
 url = "https://www.officeholidays.com/ics-clean/italy/milan"
 event_all_day_is_blocking = true
 expiration = 720 # in hours (720 hours = 30 days)
+
+[report]
+additional_attributes = ["estimated", "due", "urgency"] # additional attributes to show in the report
+# when these words are matched in the task description, the corresponding emoji is used
+emoji_keywords = {"meet"=":busts_in_silhouette:", "review"=":mag_right:"}
+include_unplanned = true # include unplanned tasks in the report in an ad-hoc section
+additional_attributes_unplanned = ["due", "urgency"] # additional attributes to show in the report for unplanned tasks
 ```
 
 ## Tips and Tricks

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

@@ -7,7 +7,6 @@ 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.egg-info/dependency_links.txt

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

@@ -1,4 +1,5 @@
 appdirs>=1.4.4
 icalendar>=6.0.1
+random-unicode-emoji>=2.8
 requests>=2.32.3
 rich>=13.9.4

taskcheck-0.3.0.post1/taskcheck/report.py

@@ -1,122 +0,0 @@
-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.3.0.post1/taskcheck/sequential.py

@@ -1,150 +0,0 @@
-from datetime import datetime, timedelta
-from taskcheck.common import (
-    get_calendars,
-    get_long_range_time_map,
-    get_tasks,
-    mark_end_date,
-    pdth_to_hours,
-    hours_to_pdth,
-    AVOID_STATUS,
-)
-
-
-def schedule_task_on_day(
-    is_starting,
-    day_offset,
-    start_date,
-    end_date,
-    task_remaining_hours,
-    task_time_map,
-    today,
-    used_hours,
-    wait,
-    scheduling_note,
-    verbose=False,
-):
-    # 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 verbose:
-            print(f"Skipping date {current_date} because of wait date {wait}")
-        return start_date, end_date, task_remaining_hours, is_starting, scheduling_note
-
-    if is_starting:
-        if verbose:
-            print(f"Starting task on {current_date}")
-        is_starting = False
-        start_date = current_date
-
-    # 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} - {hours_to_pdth(task_remaining_hours)}\n"
-        used_hours[day_offset] += task_remaining_hours
-        task_remaining_hours = 0
-        end_date = current_date
-        if verbose:
-            print(f"Task can be completed on {current_date}")
-            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} - {hours_to_pdth(employable_hours)}\n"
-        task_remaining_hours -= employable_hours
-        used_hours[day_offset] += employable_hours
-        if verbose:
-            print(f"Working for {employable_hours} hours on task on {current_date}")
-    return start_date, end_date, task_remaining_hours, is_starting, scheduling_note
-
-
-# Check if tasks can be completed on time sequentially
-def check_tasks_sequentially(config, verbose=False):
-    tasks = get_tasks()
-    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 = [0] * (config["scheduler"]["days_ahead"] + 1)
-    calendars = get_calendars(config)
-
-    while any(todo):
-        for i, task in enumerate(tasks):
-            if not todo[i]:
-                # skipping tasks already completed
-                continue
-
-            due_date = (
-                datetime.strptime(task["due"], "%Y%m%dT%H%M%SZ").date()
-                if "due" in task
-                else None
-            )
-            wait_date = (
-                datetime.strptime(task["wait"], "%Y%m%dT%H%M%SZ").date()
-                if "wait" in task
-                else None
-            )
-            estimated_hours = (
-                pdth_to_hours(task["estimated"]) if "estimated" in task else None
-            )  # Remove trailing "PT" and "H"
-            time_map_names = (
-                task.get("time_map").split(",") if "time_map" in task else None
-            )
-            if estimated_hours is None or time_map_names is None:
-                todo[i] = False
-                if verbose:
-                    print(
-                        f"Task {task['id']} ('{task['description']}') has no estimated time or time map: {estimated_hours}, {time_map_names}"
-                    )
-                continue
-            if verbose:
-                print(
-                    f"Checking task {task['id']} ('{task['description']}') with estimated hours: {estimated_hours} and wait date: {wait_date}"
-                )
-
-            task_remaining_hours = estimated_hours
-            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,
-                        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,
-                        scheduling_note,
-                        task["id"],
-                        task["description"],
-                    )
-                    break