taskcheck 0.1.1__tar.gz → 0.1.3__tar.gz

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

@@ -1,13 +1,12 @@
 Metadata-Version: 2.1
 Name: taskcheck
-Version: 0.1.1
+Version: 0.1.3
 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: requests-cache>=1.2.1
 Requires-Dist: requests>=2.32.3
 
 
@@ -46,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:
@@ -72,6 +73,7 @@ days_ahead = 1000 # how far go with the schedule (lower values make the computat
 [calendars.1]
 url = "https://your/url/to/calendar.ics"
 expiration = 0.08 # in hours (0.08 hours =~ 5 minutes)
+timezone = "Europe/Rome" # if set, force timezone for this calendar; timezone values are TZ identifiers (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
 
 [calendars.holidays]
 url = "https://www.officeholidays.com/ics-clean/italy/milan"
@@ -90,18 +92,25 @@ 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
-urgency.uda.estimated.coefficient = 1.0   # Increase urgency for tasks with longer estimated durations
-urgency.waiting.coefficient = 0.0 # you will use `wait:` to avoid scheduling tasks too much sooner
+# you will use `wait:` to avoid scheduling tasks too much sooner
+urgency.waiting.coefficient = 0.0
+# you will use `active:` to prioritize tasks already started even if the estimated amount is decreased
+urgency.active.coefficient = 3.0 
+urgency.scheduled.coefficient = 0.0 # tasks that are not scheduled may still be urgent
 
 # we need to be able to modify recurrent tasks without prompt
 recurrence.confirmation=no
 
 # suggested
-urgency.inherit=1
+urgency.inherit=1 # use dependencies to automatically prioritize tasks
 urgency.blocking.coefficient=2
 
+# give urgeny values to the estimated time
+# 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
@@ -138,11 +147,14 @@ urgency.uda.estimated.PT33H.coefficient = 11.73
 urgency.uda.estimated.PT34H.coefficient = 11.81
 urgency.uda.estimated.PT35H.coefficient = 11.89
 urgency.uda.estimated.PT36H.coefficient = 11.96
+# maximum duration is 36 hours
+
 ```
 
 ## CLI Options
 
 ```
+
 -v, --verbose: increase output verbosity
--t, --today: how much time has been already used today (default: 0)
+
 ```

{taskcheck-0.1.1 → 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:
@@ -60,6 +62,7 @@ days_ahead = 1000 # how far go with the schedule (lower values make the computat
 [calendars.1]
 url = "https://your/url/to/calendar.ics"
 expiration = 0.08 # in hours (0.08 hours =~ 5 minutes)
+timezone = "Europe/Rome" # if set, force timezone for this calendar; timezone values are TZ identifiers (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
 
 [calendars.holidays]
 url = "https://www.officeholidays.com/ics-clean/italy/milan"
@@ -78,18 +81,25 @@ 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
-urgency.uda.estimated.coefficient = 1.0   # Increase urgency for tasks with longer estimated durations
-urgency.waiting.coefficient = 0.0 # you will use `wait:` to avoid scheduling tasks too much sooner
+# you will use `wait:` to avoid scheduling tasks too much sooner
+urgency.waiting.coefficient = 0.0
+# you will use `active:` to prioritize tasks already started even if the estimated amount is decreased
+urgency.active.coefficient = 3.0 
+urgency.scheduled.coefficient = 0.0 # tasks that are not scheduled may still be urgent
 
 # we need to be able to modify recurrent tasks without prompt
 recurrence.confirmation=no
 
 # suggested
-urgency.inherit=1
+urgency.inherit=1 # use dependencies to automatically prioritize tasks
 urgency.blocking.coefficient=2
 
+# give urgeny values to the estimated time
+# 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
@@ -126,11 +136,14 @@ urgency.uda.estimated.PT33H.coefficient = 11.73
 urgency.uda.estimated.PT34H.coefficient = 11.81
 urgency.uda.estimated.PT35H.coefficient = 11.89
 urgency.uda.estimated.PT36H.coefficient = 11.96
+# maximum duration is 36 hours
+
 ```
 
 ## CLI Options
 
 ```
+
 -v, --verbose: increase output verbosity
--t, --today: how much time has been already used today (default: 0)
+
 ```

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

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

{taskcheck-0.1.1 → 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"
 )
@@ -54,11 +46,12 @@ def _hours_to_decimal(hour):
 
 def _hours_to_time(hour):
     hours = int(hour)
-    minutes = int((hour - hours) * 60)
+    minutes = int((hour - hours) * 100)
     return datetime.strptime(f"{hours}:{minutes}", "%H:%M").time()
 
 
-def _time_to_hours(time):
+def _time_to_decimal(time):
+    # round to 2 digits after the point
     return time.hour + time.minute / 60
 
 
@@ -75,6 +68,7 @@ def get_available_hours(time_map, date, calendars):
         # so let's convert them to datetime.time objects
         schedule_start = _hours_to_time(schedule_start)
         schedule_end = _hours_to_time(schedule_end)
+        schedule_blocked_hours = 0
         for calendar in calendars:
             for event in calendar:
                 # we use str to make object serializable as jsons
@@ -87,13 +81,24 @@ def get_available_hours(time_map, date, calendars):
                     break
                 elif event["end"].date() < date:
                     continue
+
                 # check if the event overlaps with one of the working hours
                 event_start = event["start"].time()
                 event_end = event["end"].time()
+                if event["start"].date() < date:
+                    event_start = datetime(date.year, date.month, date.day, 0, 0).time()
+                if event["end"].date() > date:
+                    event_end = datetime(date.year, date.month, date.day, 23, 59).time()
+
                 if event_start < schedule_end and event_end > schedule_start:
-                    blocked_hours += _time_to_hours(
+                    schedule_blocked_hours += _time_to_decimal(
                         min(schedule_end, event_end)
-                    ) - _time_to_hours(max(schedule_start, event_start))
+                    ) - _time_to_decimal(max(schedule_start, event_start))
+        if args.verbose and schedule_blocked_hours > 0:
+            print(
+                f"Blocked hours on {date} between {schedule_start} and {schedule_end}: {schedule_blocked_hours}"
+            )
+        blocked_hours += schedule_blocked_hours
     available_hours -= blocked_hours
     return available_hours
 
@@ -130,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(
@@ -143,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:
@@ -158,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
@@ -168,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(
@@ -184,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,
@@ -204,6 +235,7 @@ def get_calendars(config):
             all_day=calendar["event_all_day_is_blocking"],
             expiration=calendar["expiration"],
             verbose=args.verbose,
+            tz_name=calendar.get("timezone"),
         )
         calendar.sort(key=lambda e: e["start"])
         calendars.append(calendar)
@@ -217,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):
@@ -255,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.1 → taskcheck-0.1.3}/taskcheck/ical.py

@@ -3,38 +3,29 @@ import json
 from icalendar import Calendar
 from datetime import datetime, timedelta
 from dateutil.rrule import rruleset, rrulestr
-from requests_cache import CachedSession
+import requests
 from pathlib import Path
 import appdirs
+import zoneinfo
 
 import time
 
 CACHE = Path(appdirs.user_cache_dir("taskcheck"))
 
 
-def fetch_ical_data(url, expiration):
-    session = CachedSession(
-        "taskcheck",
-        use_cache_dir=True,  # Save files in the default user cache dir
-        cache_control=True,  # Use Cache-Control response headers for expiration, if available
-        urls_expire_after={url: expiration},  # Set expiration time
-        allowable_codes=[
-            200,
-        ],
-        allowable_methods=["GET", "POST"],  # Cache whatever HTTP methods you want
-        stale_if_error=True,  # In case of request errors, use stale cache data if possible
-    )
-    response = session.get(url)
+def fetch_ical_data(url):
+    response = requests.get(url)
     response.raise_for_status()
     return response.text
 
 
-def parse_ical_events(ical_text, days_ahead, all_day):
+def parse_ical_events(ical_text, days_ahead, all_day, tz_name=None, verbose=False):
     cal = Calendar.from_ical(ical_text)
     today = datetime.now().date()
     end_date = today + timedelta(days=days_ahead)
 
     events = []
+    exceptions = set()
 
     for component in cal.walk():
         if component.name == "VEVENT":
@@ -61,9 +52,12 @@ def parse_ical_events(ical_text, days_ahead, all_day):
                     )
                     event_end = event_start + timedelta(days=1) - timedelta(seconds=1)
             if recurrence_id:
-                continue  # Ignore recurrence exceptions here for simplicity
+                if end_date >= recurrence_id.dt.date() >= today:
+                    # this was an occurrence of a recurring event
+                    # but has been moved, let's record the exception that must be removed
+                    exceptions.add(recurrence_id.dt.isoformat())
 
-            event_dates = rruleset()
+            occurrences = rruleset()
             if recurrence_rule:
                 # avoid handling rules that are already ended
                 # and don't create events beyond end_date
@@ -72,26 +66,49 @@ def parse_ical_events(ical_text, days_ahead, all_day):
                     until = until[0].date()
                     if until < today:
                         continue
-                    elif until > end_date:
-                        recurrence_rule["UNTIL"] = end_date
                 rrule = rrulestr(
                     str(recurrence_rule.to_ical(), "utf-8"),
                     dtstart=event_start,
                 )
-                event_dates.rrule(rrule)  # type: ignore
+                occurrences.rrule(rrule)  # type: ignore
+                # exceptions to recurring events
+                excdates = component.get("exdate")
+                if excdates is not None:
+                    if isinstance(excdates, list):
+                        # concatenate all the .dts into one list
+                        excdates = [e for exdate in excdates for e in exdate.dts]
+                    else:
+                        excdates = excdates.dts
+                    for excdate in excdates:
+                        if end_date >= excdate.dt.date() >= today:
+                            exceptions.add(excdate.dt.isoformat())
             else:
-                event_dates.rdate(event_start)
-
-            for event_date in event_dates:
-                if today <= event_date.date() <= end_date:
+                # if event is not recurring, add it as a single event
+                if event_start.date() >= today and event_end.date() <= end_date:
+                    occurrences.rdate(event_start)
+
+            for occurrence in occurrences:
+                if tz_name is not None:
+                    occurrence = occurrence.astimezone(zoneinfo.ZoneInfo(tz_name))
+                end = occurrence + (event_end - event_start)
+                if occurrence.date() >= today and end.date() <= end_date:
                     events.append(
                         {
-                            "summary": component.get("summary"),
-                            "start": event_date.isoformat(),
-                            "end": event_end.isoformat(),
+                            # "summary": component.get("summary"),
+                            "start": occurrence.isoformat(),
+                            "end": end.isoformat(),
                         }
                     )
+                elif end.date() > end_date:
+                    break
 
+    with_exc_len = len(events)
+    events = [event for event in events if event["start"] not in exceptions]
+    if verbose:
+        print(
+            f"Removed {with_exc_len - len(events)} events that are exceptions to recurring events"
+        )
+    events.sort(key=lambda x: x["start"])
     return events
 
 
@@ -100,7 +117,9 @@ def get_cache_filename(url):
     return CACHE / f"{hash_object.hexdigest()}.json"
 
 
-def ical_to_dict(url, days_ahead=7, all_day=False, expiration=0.25, verbose=False):
+def ical_to_dict(
+    url, days_ahead=7, all_day=False, expiration=0.25, verbose=False, tz_name=None
+):
     CACHE.mkdir(exist_ok=True, parents=True)
     cache_file = CACHE / get_cache_filename(url)
     current_time = time.time()
@@ -117,11 +136,13 @@ def ical_to_dict(url, days_ahead=7, all_day=False, expiration=0.25, verbose=Fals
 
     # Fetch and parse iCal data
     ttt = time.time()
-    ical_text = fetch_ical_data(url, expiration * 3600)
+    ical_text = fetch_ical_data(url)
     if verbose:
         print("Time taken to fetch ical data: ", time.time() - ttt)
     ttt = time.time()
-    events = parse_ical_events(ical_text, days_ahead, all_day)
+    events = parse_ical_events(
+        ical_text, days_ahead, all_day, tz_name=tz_name, verbose=verbose
+    )
     if verbose:
         print("Time taken to parse ical data: ", time.time() - ttt)
 

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

@@ -1,13 +1,12 @@
 Metadata-Version: 2.1
 Name: taskcheck
-Version: 0.1.1
+Version: 0.1.3
 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: requests-cache>=1.2.1
 Requires-Dist: requests>=2.32.3
 
 
@@ -46,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:
@@ -72,6 +73,7 @@ days_ahead = 1000 # how far go with the schedule (lower values make the computat
 [calendars.1]
 url = "https://your/url/to/calendar.ics"
 expiration = 0.08 # in hours (0.08 hours =~ 5 minutes)
+timezone = "Europe/Rome" # if set, force timezone for this calendar; timezone values are TZ identifiers (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
 
 [calendars.holidays]
 url = "https://www.officeholidays.com/ics-clean/italy/milan"
@@ -90,18 +92,25 @@ 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
-urgency.uda.estimated.coefficient = 1.0   # Increase urgency for tasks with longer estimated durations
-urgency.waiting.coefficient = 0.0 # you will use `wait:` to avoid scheduling tasks too much sooner
+# you will use `wait:` to avoid scheduling tasks too much sooner
+urgency.waiting.coefficient = 0.0
+# you will use `active:` to prioritize tasks already started even if the estimated amount is decreased
+urgency.active.coefficient = 3.0 
+urgency.scheduled.coefficient = 0.0 # tasks that are not scheduled may still be urgent
 
 # we need to be able to modify recurrent tasks without prompt
 recurrence.confirmation=no
 
 # suggested
-urgency.inherit=1
+urgency.inherit=1 # use dependencies to automatically prioritize tasks
 urgency.blocking.coefficient=2
 
+# give urgeny values to the estimated time
+# 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
@@ -138,11 +147,14 @@ urgency.uda.estimated.PT33H.coefficient = 11.73
 urgency.uda.estimated.PT34H.coefficient = 11.81
 urgency.uda.estimated.PT35H.coefficient = 11.89
 urgency.uda.estimated.PT36H.coefficient = 11.96
+# maximum duration is 36 hours
+
 ```
 
 ## CLI Options
 
 ```
+
 -v, --verbose: increase output verbosity
--t, --today: how much time has been already used today (default: 0)
+
 ```

{taskcheck-0.1.1 → taskcheck-0.1.3}/taskcheck.egg-info/requires.txt

@@ -1,4 +1,3 @@
 appdirs>=1.4.4
 icalendar>=6.0.1
-requests-cache>=1.2.1
 requests>=2.32.3