papi-projects 0.4.2__tar.gz → 0.4.4__tar.gz

{papi_projects-0.4.2 → papi_projects-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: papi-projects
-Version: 0.4.2
+Version: 0.4.4
 Summary: PAPI is an API for managing projects
 Author-email: sandyjmacdonald <sandyjmacdonald@gmail.com>
 License-Expression: MIT

{papi_projects-0.4.2 → papi_projects-0.4.4}/papi/__init__.py

@@ -1,5 +1,6 @@
 import os
 import logging
+from decimal import Decimal, ROUND_UP
 from pathlib import Path
 
 try:
@@ -81,6 +82,18 @@ if missing:
     raise RuntimeError(f"Missing required config values: {', '.join(missing)}")
 
 
+def round_up_to_multiple(hours: float, multiple: float = 7.5) -> float:
+    """Round hours up to the nearest multiple of `multiple` (default 7.5).
+
+    Values that are already an exact multiple are left unchanged, e.g. 7.5 -> 7.5,
+    1 -> 7.5, 10 -> 15. Uses Decimal to avoid floating-point rounding surprises.
+    """
+    h = Decimal(str(hours))
+    m = Decimal(str(multiple))
+    multiples = (h / m).quantize(Decimal("1"), rounding=ROUND_UP)
+    return float(multiples * m)
+
+
 def setup_logger(enable_logging: bool, log_level: str = 'INFO', log_file: str = None):
     logger = logging.getLogger('papi')
     

{papi_projects-0.4.2 → papi_projects-0.4.4}/papi/wrappers.py

@@ -176,14 +176,18 @@ class TogglTrackWrapper(Protocol):
             if isinstance(times_json, list):
                 times = {}
                 for t in times_json:
-                    pid = t["pid"]
-                    seconds = t["duration"]
-                    hours = seconds / 60 / 60
-                    if pid not in times:
-                        times[pid] = hours
-                    else:
-                        times[pid] += hours
-                return times
+                    if "pid" in t:
+                        pid = t["pid"]
+                        seconds = t["duration"]
+                        hours = seconds / 60 / 60
+                        if pid not in times:
+                            times[pid] = hours
+                        else:
+                            times[pid] += hours
+                if times:
+                    return times
+                else:
+                    return None
             else:
                 warnings.warn(times_json)
                 return None
@@ -419,7 +423,11 @@ class NotionWrapper(Protocol):
             t = b["type"]
             if t not in ALLOWED:
                 continue
-            minimal = { "type": t, t: b[t] }
+            block_data = {
+                k: v for k, v in b[t].items()
+                if v is not None and not (k == "color" and v == "default")
+            }
+            minimal = {"type": t, t: block_data}
             if b.get("has_children"):
                 child_raw = self._fetch_template_blocks(b["id"])
                 minimal["children"] = self._clean_blocks(child_raw)
@@ -1069,20 +1077,23 @@ class NotionWrapper(Protocol):
 
         props = page.get("properties", {})
 
+        nid = page.get("id")
         try:
             pid = project_id or props["Project ID"]["title"][0]["plain_text"]
             name = props["Description"]["rich_text"][0]["plain_text"]
-            owner = [u["name"] for u in props["Owner"]["people"]]
+            owner = [u.get("name") for u in props["Owner"]["people"] if u.get("name")]
             status = props["Status"]["status"]["name"]
             priority = props["Priority"]["select"]["name"]
             user_id = props["PI Code"]["rollup"]["array"][0]["rich_text"][0]["plain_text"]
-            nid = page["id"]
             if len(props["Workorder"]["relation"]):
                 workorder_page_id = props["Workorder"]["relation"][0]["id"]
             else:
                 workorder_page_id = None
         except (KeyError, IndexError) as e:
-            logger.error(f"Malformed project properties on page {nid!r}: {e!r}")
+            logger.error(
+                f"Malformed project properties for Project ID={project_id!r} "
+                f"on Notion page {nid!r}: {e!r}"
+            )
             return None
 
         if workorders_db_id is not None and workorder_page_id is not None:

{papi_projects-0.4.2 → papi_projects-0.4.4}/papi_projects.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: papi-projects
-Version: 0.4.2
+Version: 0.4.4
 Summary: PAPI is an API for managing projects
 Author-email: sandyjmacdonald <sandyjmacdonald@gmail.com>
 License-Expression: MIT

{papi_projects-0.4.2 → papi_projects-0.4.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "papi-projects"
-version = "0.4.2"
+version = "0.4.4"
 description = "PAPI is an API for managing projects"
 authors = [{ name = "sandyjmacdonald", email = "sandyjmacdonald@gmail.com" }]
 license = "MIT"

{papi_projects-0.4.2 → papi_projects-0.4.4}/scripts/collate_toggl_hours.py

@@ -2,7 +2,7 @@ import argparse
 import pendulum
 import warnings
 from papi.wrappers import TogglTrackWrapper
-from papi import config
+from papi import config, round_up_to_multiple
 
 def main():
     """Main function of collate-toggl-hours script"""
@@ -22,6 +22,11 @@ def main():
         help="output TSV filename, omit to write to stdout",
         default=False,
     )
+    parser.add_argument(
+        "--round",
+        action="store_true",
+        help="round each project's total hours up to the nearest 7.5",
+    )
     args = parser.parse_args()
 
     # Set up start/end date
@@ -51,9 +56,13 @@ def main():
         # Get tracked hours and tracked project IDs/names
 
         tracked_hours = toggl.get_user_hours(start_time=start_time, end_time=end_time)
+        print(tracked_hours)
         projects = {p["id"]: p["name"] for p in toggl.get_user_projects() if p["id"] in tracked_hours}
         hours_per_project = [(projects[t], tracked_hours[t]) for t in tracked_hours]
 
+        if args.round:
+            hours_per_project = [(name, round_up_to_multiple(hours)) for name, hours in hours_per_project]
+
         output = args.output
 
         if output:
@@ -69,4 +78,4 @@ def main():
         warnings.warn("Start time must not be more than 3 months ago!")
 
 if __name__ == "__main__":
-    main()
+    main()

papi_projects-0.4.4/scripts/generate_timesheet.py

@@ -0,0 +1,242 @@
+import argparse
+import pendulum
+import warnings
+import os
+from pathlib import Path
+from papi.wrappers import TogglTrackWrapper, NotionWrapper
+from papi import config, setup_logger, round_up_to_multiple
+from papi.project import get_project_ids, check_project_id
+from decimal import Decimal, ROUND_UP
+import pandas as pd
+
+try:
+    import tomllib
+except ModuleNotFoundError:
+    import tomli as tomllib
+
+def load_toggl_users_from_toml():
+    config_path = os.environ.get("PAPI_CONFIG_FILE")
+    if config_path:
+        path = Path(config_path).expanduser()
+    else:
+        path = Path.home() / ".config" / "papi" / "config.toml"
+    if not path.exists():
+        return []
+    with path.open("rb") as f:
+        raw = tomllib.load(f)
+    toggl = raw.get("toggl", {})
+    users = toggl.get("users", {})
+    out = []
+    if isinstance(users, dict):
+        for _, u in users.items():
+            if not isinstance(u, dict):
+                continue
+            name = u.get("name")
+            api_key = u.get("api_key")
+            if name and api_key:
+                out.append({"name": name, "api_key": api_key})
+    return out
+
+def initialise_toggl(toggl_api_key, toggl_workspace):
+    toggl_api_password = config["TOGGL_TRACK_PASSWORD"]
+    toggl = TogglTrackWrapper(toggl_api_key, toggl_api_password)
+    toggl.set_default_workspace(toggl_workspace)
+    toggl.set_me()
+    return toggl
+
+def calculate_cost(hours: float, hourly_rate: float) -> float:
+    cost = Decimal(hours * hourly_rate)
+    cost_rounded = cost.quantize(Decimal("0.01"), rounding=ROUND_UP)
+    return cost_rounded
+
+def get_toggl_hours(start_time, end_time, toggl):
+    tracked_hours = toggl.get_user_hours(start_time=start_time, end_time=end_time)
+    if not tracked_hours:
+        return {}
+    projects = {p["id"]: p["name"] for p in toggl.get_user_projects() if p["id"] in tracked_hours}
+    hours_per_project = [(projects[t], tracked_hours[t]) for t in tracked_hours]
+    hours_dict = {}
+    for i, p in enumerate(hours_per_project):
+        project_id = get_project_ids([p[0]])
+        if len(project_id):
+            hours_dict[project_id[0]] = hours_per_project[i][1]
+        else:
+            hours_dict[p[0]] = hours_per_project[i][1]
+    return hours_dict
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-s", "--start", type=str, required=True)
+    parser.add_argument("-e", "--end", type=str, default=False)
+    parser.add_argument("--disable-logging", action="store_true")
+    parser.add_argument(
+        "--round",
+        action="store_true",
+        help="round each project's total hours (across all users) up to the nearest 7.5",
+    )
+    parser.add_argument("-o", "--output", type=str, required=True)
+    args = parser.parse_args()
+
+    if not args.disable_logging:
+        logger = setup_logger(True, "WARNING", None)
+
+    start_time = pendulum.parse(args.start).to_rfc3339_string()
+    # Toggl's end_date is exclusive, so add a day to include entries on the end date itself.
+    end_time = pendulum.now().to_rfc3339_string() if not args.end else pendulum.parse(args.end).add(days=1).to_rfc3339_string()
+
+    if pendulum.now() < pendulum.parse(args.start).add(months=3):
+        toggl_workspace = config["TOGGL_TRACK_WORKSPACE"]
+        toggl_users = load_toggl_users_from_toml()
+        if not toggl_users:
+            toggl_users = [{"name": "Self", "api_key": config["TOGGL_TRACK_API_KEY"]}]
+
+        notion = NotionWrapper(config["NOTION_API_SECRET"])
+        output = args.output
+
+        df = pd.DataFrame(
+            columns=[
+                "workorder",
+                "project_id",
+                "payment_type",
+                "costing_rate",
+                "hourly_rate",
+                "hours",
+                "cost",
+                "person",
+                "description",
+                "agresso_description",
+            ]
+        )
+
+        for user in toggl_users:
+            print(user)
+            toggl = initialise_toggl(user["api_key"], toggl_workspace)
+            try:
+                hours_dict = get_toggl_hours(start_time, end_time, toggl)
+            except Exception:
+                logger.error(f"[Toggl] Failed fetching hours for user {user['name']!r}")
+                raise
+            if not hours_dict:
+                logger.warning(
+                    f"[Toggl] No hours tracked for user {user['name']!r} "
+                    f"in the requested period; skipping."
+                )
+                continue
+            print(hours_dict)
+
+            for project_id, hours in hours_dict.items():
+                hours = float(hours)
+                payment_type = ""
+                costing_rate = ""
+                hourly_rate = ""
+                cost = 0.0
+                workorder_id = ""
+                if check_project_id(project_id):
+                    try:
+                        project = notion.get_project(
+                            config["NOTION_PROJECTS_DB"],
+                            project_id,
+                            workorders_db_id=config["NOTION_WORKORDERS_DB"]
+                        )
+                        if project is not None:
+                            project_name = project.name
+                            workorder_id = project.workorder
+                            if workorder_id is not None:
+                                workorder = notion.get_workorder(
+                                    workorders_db_id=config["NOTION_WORKORDERS_DB"],
+                                    workorder_id=workorder_id
+                                )
+                                if workorder.is_complete():
+                                    payment_type = workorder.payment_type
+                                    costing_rate = workorder.costing_rate
+                                    hourly_rate = workorder.hourly_rate
+                                    cost = calculate_cost(hours, workorder.hourly_rate)
+                        else:
+                            project_name = ""
+                            workorder_id = ""
+                    except Exception:
+                        logger.error(
+                            f"[Notion] Failed processing project {project_id!r} "
+                            f"for user {user['name']!r}"
+                        )
+                        raise
+                else:
+                    project_name = project_id
+
+                df.loc[len(df)] = [
+                    workorder_id,
+                    project_id,
+                    payment_type,
+                    costing_rate,
+                    hourly_rate,
+                    hours,
+                    cost,
+                    user["name"],
+                    project_name,
+                    f"{project_id}: {project_name}",
+                ]
+
+        output_path = Path(output).expanduser()
+        itemised_path = output_path.with_name(f"{output_path.stem}-itemised{output_path.suffix}")
+        totals_path = output_path.with_name(f"{output_path.stem}-totals{output_path.suffix}")
+        da_path = output_path.with_name(f"{output_path.stem}-DA{output_path.suffix}")
+        di_path = output_path.with_name(f"{output_path.stem}-DI{output_path.suffix}")
+
+        df.to_csv(itemised_path, sep="\t", index=False)
+
+        totals_df = df.drop(columns=["person"]).groupby("project_id", as_index=False).agg(
+            {
+                "workorder": "first",
+                "payment_type": "first",
+                "costing_rate": "first",
+                "hourly_rate": "first",
+                "hours": "sum",
+                "cost": "sum",
+                "description": "first",
+                "agresso_description": "first",
+            }
+        )
+        totals_df = totals_df[
+            [
+                "workorder",
+                "project_id",
+                "payment_type",
+                "costing_rate",
+                "hourly_rate",
+                "hours",
+                "cost",
+                "description",
+                "agresso_description",
+            ]
+        ]
+
+        if args.round:
+            totals_df["hours"] = totals_df["hours"].apply(round_up_to_multiple)
+            totals_df["cost"] = totals_df.apply(
+                lambda row: calculate_cost(row["hours"], row["hourly_rate"])
+                if row["hourly_rate"] not in ("", None)
+                else row["cost"],
+                axis=1,
+            )
+
+        totals_df.to_csv(totals_path, sep="\t", index=False)
+
+        da_df = totals_df[totals_df["payment_type"] == "DA"]
+        if len(da_df):
+            da_df.to_csv(da_path, sep="\t", index=False)
+
+        di_df = totals_df[totals_df["payment_type"] == "DI"]
+        if len(di_df):
+            di_df.to_csv(di_path, sep="\t", index=False)
+
+        logger.warning(f"{len(df)} journal entries successfully written to {itemised_path}")
+        logger.warning(f"{len(totals_df)} project totals successfully written to {totals_path}")
+        if len(da_df):
+            logger.warning(f"{len(da_df)} DA totals successfully written to {da_path}")
+        if len(di_df):
+            logger.warning(f"{len(di_df)} DI totals successfully written to {di_path}")
+    else:
+        logger.warning("Start time must not be more than 3 months ago!")
+
+if __name__ == "__main__":
+    main()

papi_projects-0.4.2/scripts/generate_timesheet.py

@@ -1,154 +0,0 @@
-import argparse
-import pendulum
-import warnings
-import os
-from pathlib import Path
-from papi.wrappers import TogglTrackWrapper, NotionWrapper
-from papi import config, setup_logger
-from papi.project import get_project_ids, check_project_id
-from decimal import Decimal, ROUND_UP
-import pandas as pd
-
-try:
-    import tomllib
-except ModuleNotFoundError:
-    import tomli as tomllib
-
-def load_toggl_users_from_toml():
-    config_path = os.environ.get("PAPI_CONFIG_FILE")
-    if config_path:
-        path = Path(config_path).expanduser()
-    else:
-        path = Path.home() / ".config" / "papi" / "config.toml"
-    if not path.exists():
-        return []
-    with path.open("rb") as f:
-        raw = tomllib.load(f)
-    toggl = raw.get("toggl", {})
-    users = toggl.get("users", {})
-    out = []
-    if isinstance(users, dict):
-        for _, u in users.items():
-            if not isinstance(u, dict):
-                continue
-            name = u.get("name")
-            api_key = u.get("api_key")
-            if name and api_key:
-                out.append({"name": name, "api_key": api_key})
-    return out
-
-def initialise_toggl(toggl_api_key, toggl_workspace):
-    toggl_api_password = config["TOGGL_TRACK_PASSWORD"]
-    toggl = TogglTrackWrapper(toggl_api_key, toggl_api_password)
-    toggl.set_default_workspace(toggl_workspace)
-    toggl.set_me()
-    return toggl
-
-def calculate_cost(hours: float, hourly_rate: float) -> float:
-    cost = Decimal(hours * hourly_rate)
-    cost_rounded = cost.quantize(Decimal("0.01"), rounding=ROUND_UP)
-    return cost_rounded
-
-def get_toggl_hours(start_time, end_time, toggl):
-    tracked_hours = toggl.get_user_hours(start_time=start_time, end_time=end_time)
-    projects = {p["id"]: p["name"] for p in toggl.get_user_projects() if p["id"] in tracked_hours}
-    hours_per_project = [(projects[t], tracked_hours[t]) for t in tracked_hours]
-    hours_dict = {}
-    for i, p in enumerate(hours_per_project):
-        project_id = get_project_ids([p[0]])
-        if len(project_id):
-            hours_dict[project_id[0]] = hours_per_project[i][1]
-        else:
-            hours_dict[p[0]] = hours_per_project[i][1]
-    return hours_dict
-
-def main():
-    parser = argparse.ArgumentParser()
-    parser.add_argument("-s", "--start", type=str, required=True)
-    parser.add_argument("-e", "--end", type=str, default=False)
-    parser.add_argument("--disable-logging", action="store_true")
-    parser.add_argument("-o", "--output", type=str, required=True)
-    args = parser.parse_args()
-
-    if not args.disable_logging:
-        logger = setup_logger(True, "WARNING", None)
-
-    start_time = pendulum.parse(args.start).to_rfc3339_string()
-    end_time = pendulum.now().to_rfc3339_string() if not args.end else pendulum.parse(args.end).to_rfc3339_string()
-
-    if pendulum.now() < pendulum.parse(args.start).add(months=3):
-        toggl_workspace = config["TOGGL_TRACK_WORKSPACE"]
-        toggl_users = load_toggl_users_from_toml()
-        if not toggl_users:
-            toggl_users = [{"name": "Self", "api_key": config["TOGGL_TRACK_API_KEY"]}]
-
-        notion = NotionWrapper(config["NOTION_API_SECRET"])
-        output = args.output
-
-        df = pd.DataFrame(
-            columns=[
-                "workorder",
-                "project_id",
-                "payment_type",
-                "costing_rate",
-                "hourly_rate",
-                "hours",
-                "cost",
-                "person",
-                "description",
-                "agresso_description",
-            ]
-        )
-
-        for user in toggl_users:
-            toggl = initialise_toggl(user["api_key"], toggl_workspace)
-            hours_dict = get_toggl_hours(start_time, end_time, toggl)
-
-            for project_id, hours in hours_dict.items():
-                hours = float(hours)
-                payment_type = ""
-                costing_rate = ""
-                hourly_rate = ""
-                cost = 0.0
-                workorder_id = ""
-                if check_project_id(project_id):
-                    project = notion.get_project(
-                        config["NOTION_PROJECTS_DB"],
-                        project_id,
-                        workorders_db_id=config["NOTION_WORKORDERS_DB"]
-                    )
-                    project_name = project.name
-                    workorder_id = project.workorder
-                    if workorder_id is not None:
-                        workorder = notion.get_workorder(
-                            workorders_db_id=config["NOTION_WORKORDERS_DB"],
-                            workorder_id=workorder_id
-                        )
-                        if workorder.is_complete():
-                            payment_type = workorder.payment_type
-                            costing_rate = workorder.costing_rate
-                            hourly_rate = workorder.hourly_rate
-                            cost = calculate_cost(hours, workorder.hourly_rate)
-                else:
-                    project_name = project_id
-
-                df.loc[len(df)] = [
-                    workorder_id,
-                    project_id,
-                    payment_type,
-                    costing_rate,
-                    hourly_rate,
-                    hours,
-                    cost,
-                    user["name"],
-                    project_name,
-                    f"{project_id}: {project_name}",
-                ]
-
-        df.to_csv(output, sep="\t", index=False)
-        logger.warning(f"{len(df)} journal entries successfully written to {output}")
-    else:
-        logger.warning("Start time must not be more than 3 months ago!")
-
-if __name__ == "__main__":
-    main()