papi-projects 0.2.3__tar.gz → 0.2.5__tar.gz

{papi_projects-0.2.3 → papi_projects-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: papi-projects
-Version: 0.2.3
+Version: 0.2.5
 Summary: PAPI is an API for managing projects
 License: MIT
 Author: sandyjmacdonald

{papi_projects-0.2.3 → papi_projects-0.2.5}/papi/wrappers.py

@@ -436,7 +436,8 @@ class TogglTrackWrapper(Protocol):
         self, start_time=None, end_time=pendulum.now().to_rfc3339_string()
     ) -> dict:
         """Gets all of the Toggl Track user's tracked hours for a given
-        time period. If no end_time is given, then the current time is used.
+        time period. If no end_time is given, then the current time is used. 
+        Only works with start dates up to a maximum of three months ago.
 
         :return: A dictionary containing the Toggl Track projects and hours tracked.
         :rtype: dict
@@ -449,16 +450,20 @@ class TogglTrackWrapper(Protocol):
                 params={"start_date": start_time, "end_date": end_time},
             )
             times_json = r.json()
-            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 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
+            else:
+                warnings.warn(times_json)
+                return None
         else:
             warnings.warn("Please provide a valid start date/time in RFC3339 format!")
             return None
@@ -618,6 +623,89 @@ class NotionWrapper(Protocol):
         self.api_secret = api_secret
         logger.info("NotionWrapper instance created")
 
+    def _headers(self) -> dict:
+        return {
+            "Authorization": f"Bearer {self.api_secret}",
+            "Notion-Version": "2022-06-28",
+            "Content-Type": "application/json",
+        }
+
+    def _fetch_template_page(self, template_page_id: str) -> dict:
+        """Retrieve the template page’s properties."""
+        r = httpx.get(
+            f"https://api.notion.com/v1/pages/{template_page_id}",
+            headers=self._headers()
+        )
+        r.raise_for_status()
+        return r.json()
+
+    def _fetch_template_blocks(self, template_page_id: str) -> list[dict]:
+        """Page through and collect all child blocks of the template."""
+        blocks: list[dict] = []
+        url = f"https://api.notion.com/v1/blocks/{template_page_id}/children"
+        params = {"page_size": 100}
+        while True:
+            r = httpx.get(url, headers=self._headers(), params=params)
+            r.raise_for_status()
+            js = r.json()
+            blocks.extend(js["results"])
+            if not js.get("has_more"):
+                break
+            params = {"start_cursor": js["next_cursor"], "page_size": 100}
+        return blocks
+
+    def _clean_properties(self, raw: dict) -> dict:
+        """Strip out IDs, types, rollup/formula wrappers, leaving only the API-legal values."""
+        clean = {}
+        for name, meta in raw.items():
+            t = meta.get("type")
+            if t == "title":
+                clean[name] = meta["title"]
+            elif t == "rich_text":
+                clean[name] = meta["rich_text"]
+            elif t == "select":
+                sel = meta.get("select")
+                if sel and sel.get("name"):
+                    clean[name] = {"name": sel["name"]}
+            elif t == "multi_select":
+                clean[name] = [
+                    {"name": m["name"]} for m in meta.get("multi_select", []) if m.get("name")
+                ]
+            elif t == "status":
+                st = meta.get("status")
+                if st and st.get("name"):
+                    clean[name] = {"name": st["name"]}
+            elif t == "date":
+                d = meta.get("date")
+                if d and d.get("start"):
+                    # include end only if present
+                    clean[name] = {"start": d["start"], **({"end": d["end"]} if d.get("end") else {})}
+            elif t in ("people", "relation"):
+                # both use a list of {id:…}
+                key = t
+                clean[name] = [ {"id": x["id"]} for x in meta.get(key, []) if x.get("id") ]
+            # skip formula, rollup, files, etc.
+        return clean
+
+    def _clean_blocks(self, raw_blocks: list[dict]) -> list[dict]:
+        ALLOWED = {
+            "paragraph","heading_1","heading_2","heading_3",
+            "to_do","bulleted_list_item","numbered_list_item",
+            "toggle","quote","callout",
+            "image","video","file","embed","bookmark",
+        }
+        clean = []
+        for b in raw_blocks:
+            t = b["type"]
+            if t not in ALLOWED:
+                continue
+            minimal = { "type": t, t: b[t] }
+            if b.get("has_children"):
+                child_raw = self._fetch_template_blocks(b["id"])
+                minimal["children"] = self._clean_blocks(child_raw)
+            clean.append(minimal)
+        return clean
+
     def create_user(self, user: User, clients_db_id: str) -> str:
         """Creates a Notion client (user) from a `User` instance.
 
@@ -634,10 +722,7 @@ class NotionWrapper(Protocol):
         user_name = user.user_name
         user_id = user.user_id
         email = user.email
-        headers = {
-            "Authorization": f"Bearer {self.api_secret}",
-            "Notion-Version": "2022-06-28",
-        }
+        headers = self._headers()
         data = {
             "parent": {"database_id": clients_db_id},
             "properties": {
@@ -707,10 +792,7 @@ class NotionWrapper(Protocol):
         """
         logger.debug("Calling NotionWrapper.get_user_page_id method")
         user_id = user.user_id
-        headers = {
-            "Authorization": f"Bearer {self.api_secret}",
-            "Notion-Version": "2022-06-28",
-        }
+        headers = self._headers()
         data = {
             "filter": {
                 "property": "Code",
@@ -744,10 +826,7 @@ class NotionWrapper(Protocol):
         :rtype: list
         """
         logger.debug("Calling NotionWrapper.get_users method")
-        headers = {
-            "Authorization": f"Bearer {self.api_secret}",
-            "Notion-Version": "2022-06-28",
-        }
+        headers = self._headers()
         data = {}
         r = httpx.post(
             f"https://api.notion.com/v1/databases/{clients_db_id}/query",
@@ -768,155 +847,80 @@ class NotionWrapper(Protocol):
             logger.warning("No Notion users found")
         return users
 
-    def create_project(self, project: Project, user: User, projects_db_id: str, user_page_id=None) -> str:
-        """Creates a new project on Notion.
-        
+    def create_project(
+        self,
+        project: Project,
+        user: User,
+        projects_db_id: str,
+        user_page_id: str | None = None,
+        template_page_id: str | None = None,
+    ) -> str:
+        """
+        Creates a new project on Notion, optionally cloning from a database template.
+
         :param project: A Project instance.
-        :type project: Project
         :param user: A User instance.
-        :type user: User
-        :param projects_db_id: ID of the Notion projects database in which to add the project.
-        :type projects_db_id: str
-        :param user_page_id: ID of the user in Notion, if they've been added. Can get this with 
-        get_user_page_id function.
-        :type user_page_id: str
-        :return: The page ID of the project created in Notion.
-        :rtype: str
+        :param projects_db_id: ID of the Notion projects database.
+        :param user_page_id: ID of the user in Notion (for the PI relation).
+        :param template_page_id: If given, we’ll fetch that page’s properties & children
+                                 and use them as the base for this new record.
+        :return: The page ID of the created project.
         """
         logger.debug("Calling NotionWrapper.create_project method")
-        project_id = project.id
-        project_name = project.name
-        user_id = user.user_id
-        if user_page_id is not None:
-            pi_relation = [{"id": user_page_id}]
+        headers = self._headers()
+
+        # 1) Fetch & clean template if requested
+        if template_page_id:
+            tpl_raw     = self._fetch_template_page(template_page_id)
+            base_props  = self._clean_properties(tpl_raw["properties"])
+            raw_blocks  = self._fetch_template_blocks(template_page_id)
+            base_blocks = self._clean_blocks(raw_blocks)
         else:
-            pi_relation = []
-        headers = {
-            "Authorization": f"Bearer {self.api_secret}",
-            "Notion-Version": "2022-06-28",
+            base_props, base_blocks = {}, []
+
+        # 2) Build project-specific overrides in the exact shape Notion expects
+        overrides = {
+            "Project ID": [
+                {
+                    "type": "text",
+                    "text": {"content": project.id}
+                }
+            ],
+            "Description": [
+                {
+                    "type": "text",
+                    "text": {"content": project.name}
+                }
+            ],
+            "PI": [{"id": user_page_id}] if user_page_id else [],
+            # you can add more dynamic fields here (dates, selects, etc.)
         }
-        data = {
-            "parent": {"database_id": projects_db_id},
-            "properties": {
-                "Status": {
-                    "status": None,
-                },
-                "Description": {
-                    "type": "rich_text",
-                    "rich_text": [
-                        {
-                            "type": "text",
-                            "text": {
-                                "content": project_name,
-                                "link": None,
-                            },
-                            "annotations": {
-                                "bold": False,
-                                "italic": False,
-                                "strikethrough": False,
-                                "underline": False,
-                                "code": False,
-                                "color": "default",
-                            },
-                            "plain_text": project_name,
-                            "href": None,
-                        }
-                    ],
-                },
-                "Hourly Rate": {
-                    "type": "number",
-                    "number": 0.0,  # Set an appropriate number
-                },
-                "Slug": {
-                    "type": "rich_text",
-                    "rich_text": [
-                        {
-                            "type": "text",
-                            "text": {"content": project_name, "link": None},
-                            "annotations": {
-                                "bold": False,
-                                "italic": False,
-                                "strikethrough": False,
-                                "underline": False,
-                                "code": False,
-                                "color": "default",
-                            },
-                            "plain_text": project_name,
-                            "href": None,
-                        }
-                    ],
-                },
-                "Type": {
-                    "type": "select",  # Assuming Type is a select property
-                    "select": None,
-                },
-                "PI Code": {
-                    "type": "rich_text",
-                    "rich_text": [
-                        {
-                            "type": "text",
-                            "text": {"content": user_id, "link": None},
-                            "annotations": {
-                                "bold": False,
-                                "italic": False,
-                                "strikethrough": False,
-                                "underline": False,
-                                "code": False,
-                                "color": "default",
-                            },
-                            "plain_text": user_id,
-                            "href": None,
-                        }
-                    ],
-                },
-                "Priority": {
-                    "type": "select",
-                    "select": None,
-                },
-                "Tags": {
-                    "type": "multi_select",
-                    "multi_select": [],
-                },
-                "PI": {
-                    "type": "relation",
-                    "relation": pi_relation,
-                    "has_more": False,
-                },
-                "Start Date": {
-                    "type": "date",
-                    # "date": {"start": "2024-09-12", "end": None, "time_zone": None},
-                    "date": None,
-                },
-                "Owner": {
-                    "type": "people",
-                    "people": [],
-                },
-                "Project ID": {
-                    "type": "title",
-                    "title": [
-                        {
-                            "type": "text",
-                            "text": {"content": project_id, "link": None},
-                            "annotations": {
-                                "bold": False,
-                                "italic": False,
-                                "strikethrough": False,
-                                "underline": False,
-                                "code": False,
-                                "color": "default",
-                            },
-                            "plain_text": project_id,
-                            "href": None,
-                        }
-                    ],
-                },
-            },
+
+        # 3) Merge so overrides win
+        merged_props = {**base_props, **overrides}
+
+        # 4) Build payload
+        payload: dict = {
+            "parent":     {"database_id": projects_db_id},
+            "properties": merged_props,
         }
-        r = httpx.post("https://api.notion.com/v1/pages", headers=headers, json=data)
-        r_json = r.json()
-        page_id = r_json["id"]
-        logger.info(f"Notion project created with page ID {page_id}")
-        return page_id
+        if base_blocks:
+            payload["children"] = base_blocks
+
+        # 5) Send and handle errors
+        r = httpx.post("https://api.notion.com/v1/pages", headers=headers, json=payload)
+        try:
+            r.raise_for_status()
+        except httpx.HTTPStatusError:
+            print("→ Request JSON:")
+            print(json.dumps(payload, indent=2))
+            print("→ Notion error response:")
+            print(r.json())
+            raise
+
+        new_page_id = r.json()["id"]
+        logger.info(f"Notion project cloned from template as page ID {new_page_id}")
+        return new_page_id
 
     def get_projects(self, projects_db_id: str) -> list:
         """Gets the Notion projects from the Clients database.
@@ -928,10 +932,7 @@ class NotionWrapper(Protocol):
         :rtype: list
         """
         logger.debug("Calling NotionWrapper.get_projects method")
-        headers = {
-            "Authorization": f"Bearer {self.api_secret}",
-            "Notion-Version": "2022-06-28",
-        }
+        headers = self._headers()
         data = {}
         r = httpx.post(
             f"https://api.notion.com/v1/databases/{projects_db_id}/query",

{papi_projects-0.2.3 → papi_projects-0.2.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "papi-projects"
-version = "0.2.3"
+version = "0.2.5"
 description = "PAPI is an API for managing projects"
 authors = ["sandyjmacdonald <sandyjmacdonald@gmail.com>"]
 license = "MIT"

papi_projects-0.2.5/scripts/collate_toggl_hours.py

@@ -0,0 +1,72 @@
+import argparse
+import pendulum
+import warnings
+from papi.wrappers import TogglTrackWrapper
+from papi import config
+
+def main():
+    """Main function of collate-toggl-hours script"""
+
+    # Set up argparse
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "-s", "--start", type=str, help="start date in YYYY-MM-DD format", required=True
+    )
+    parser.add_argument(
+        "-e", "--end", type=str, help="end date in YYYY-MM-DD format, if none supplied then end date is now", default=False
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        type=str,
+        help="output TSV filename, omit to write to stdout",
+        default=False,
+    )
+    args = parser.parse_args()
+
+    # Set up start/end date
+    start_date = args.start
+    start_time = pendulum.parse(start_date).to_rfc3339_string()
+    end_date = args.end
+    if not end_date:
+        end_time = pendulum.now().to_rfc3339_string()
+    else:
+        end_time = pendulum.parse(end_date).to_rfc3339_string()
+
+    # Check that start time is not more than 3 months ago
+    if pendulum.now() < pendulum.parse(start_date).add(months=3):
+        # Set up Toggl Track API wrapper
+        #
+        # NOTE: you must have added Toggl Track API key and password, with
+        # variable names below to .env file in this directory
+        toggl_api_key = config["TOGGL_TRACK_API_KEY"]
+        toggl_api_password = config["TOGGL_TRACK_PASSWORD"]
+        toggl = TogglTrackWrapper(toggl_api_key, toggl_api_password)
+
+        # Tell wrapper which workspace to set as default
+        toggl_workspace = config["TOGGL_TRACK_WORKSPACE"]
+        toggl.set_default_workspace(toggl_workspace)
+        toggl.set_me()
+
+        # Get tracked hours and tracked project IDs/names
+
+        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]
+
+        output = args.output
+
+        if output:
+            # If output filename provided, write to file
+            with open(output, "w") as out:
+                for h in sorted(hours_per_project, key=lambda x:x[1], reverse=True):
+                    out.write(f"{h[0]}\t{h[1]}\n")
+        else:
+            # Otherwise, print out project names and tracked hours to stdout
+            for h in sorted(hours_per_project, key=lambda x:x[1], reverse=True):
+                print(f"{h[0]}\t{h[1]}")
+    else:
+        warnings.warn("Start time must not be more than 3 months ago!")
+
+if __name__ == "__main__":
+    main()

{papi_projects-0.2.3 → papi_projects-0.2.5}/scripts/create_notion_project.py

@@ -39,12 +39,13 @@ def main():
     #
     # NOTE: you must have added your Notion API credentials and user and projects
     # database IDs with variable names below to .env file in this directory
-    if "NOTION_API_SECRET"not in config and "NOTION_CLIENTS_DB" not in config and "NOTION_PROJECTS_DB" not in config:
+    if "NOTION_API_SECRET" not in config and "NOTION_CLIENTS_DB" not in config and "NOTION_PROJECTS_DB" not in config:
         logger.warning("Please create a .env file with NOTION_API_SECRET and NOTION_CLIENTS_DB and NOTION_PROJECTS_DB set!")
         return  
     notion_api_secret = config["NOTION_API_SECRET"]
     notion_clients_db = config["NOTION_CLIENTS_DB"]
     notion_projects_db = config["NOTION_PROJECTS_DB"]
+    notion_template_page_id = config["NOTION_TEMPLATE_PAGE_ID"]
     notion = NotionWrapper(notion_api_secret)
 
     user_id = args.user_id
@@ -75,9 +76,9 @@ def main():
     # Create project on Notion
     user_page_id = notion.get_user_page_id(notion_clients_db, user)
     if user_page_id is not None:
-        notion_proj_id = notion.create_project(project, user, notion_projects_db, user_page_id=user_page_id)
+        notion_proj_id = notion.create_project(project, user, notion_projects_db, user_page_id=user_page_id, template_page_id=notion_template_page_id)
     else:
-        notion_proj_id = notion.create_project(project, user, notion_projects_db)
+        notion_proj_id = notion.create_project(project, user, notion_projects_db, template_page_id=notion_template_page_id)
     
     pyperclip.copy(project.id)
 

{papi_projects-0.2.3 → papi_projects-0.2.5}/scripts/create_project.py

@@ -159,14 +159,15 @@ def main():
         notion_api_secret = config["NOTION_API_SECRET"]
         notion_clients_db = config["NOTION_CLIENTS_DB"]
         notion_projects_db = config["NOTION_PROJECTS_DB"]
+        notion_template_page_id = config["NOTION_TEMPLATE_PAGE_ID"]
         notion = NotionWrapper(notion_api_secret)
 
         # Create project on Notion
         user_page_id = notion.get_user_page_id(notion_clients_db, user)
         if user_page_id is not None:
-            notion_proj_id = notion.create_project(project, user, notion_projects_db, user_page_id=user_page_id)
+            notion_proj_id = notion.create_project(project, user, notion_projects_db, user_page_id=user_page_id, template_page_id=notion_template_page_id)
         else:
-            notion_proj_id = notion.create_project(project, user, notion_projects_db)
+            notion_proj_id = notion.create_project(project, user, notion_projects_db, template_page_id=notion_template_page_id)
         
     pyperclip.copy(project.id)
 

papi_projects-0.2.3/scripts/collate_toggl_hours.py

@@ -1,66 +0,0 @@
-import argparse
-import pendulum
-from papi.wrappers import TogglTrackWrapper
-from papi import config
-
-def main():
-    """Main function of collate-toggl-hours script"""
-
-    # Set up argparse
-    parser = argparse.ArgumentParser()
-    parser.add_argument(
-        "-s", "--start", type=str, help="start date in YYYY-MM-DD format", required=True
-    )
-    parser.add_argument(
-        "-e", "--end", type=str, help="end date in YYYY-MM-DD format, if none supplied then end date is now", default=False
-    )
-    parser.add_argument(
-        "-o",
-        "--output",
-        type=str,
-        help="output TSV filename, omit to write to stdout",
-        default=False,
-    )
-    args = parser.parse_args()
-
-    # Set up start/end date
-    start_date = args.start
-    start_time = pendulum.parse(start_date).to_rfc3339_string()
-    end_date = args.end
-    if not end_date:
-        end_time = pendulum.now().to_rfc3339_string()
-    else:
-        end_time = pendulum.parse(end_date).to_rfc3339_string()
-
-    # Set up Toggl Track API wrapper
-    #
-    # NOTE: you must have added Toggl Track API key and password, with
-    # variable names below to .env file in this directory
-    toggl_api_key = config["TOGGL_TRACK_API_KEY"]
-    toggl_api_password = config["TOGGL_TRACK_PASSWORD"]
-    toggl = TogglTrackWrapper(toggl_api_key, toggl_api_password)
-
-    # Tell wrapper which workspace to set as default
-    toggl_workspace = config["TOGGL_TRACK_WORKSPACE"]
-    toggl.set_default_workspace(toggl_workspace)
-    toggl.set_me()
-
-    # Get tracked hours and tracked project IDs/names
-    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]
-
-    output = args.output
-
-    if output:
-        # If output filename provided, write to file
-        with open(output, "w") as out:
-            for h in sorted(hours_per_project, key=lambda x:x[1], reverse=True):
-                out.write(f"{h[0]}\t{h[1]}\n")
-    else:
-        # Otherwise, print out project names and tracked hours to stdout
-        for h in sorted(hours_per_project, key=lambda x:x[1], reverse=True):
-            print(f"{h[0]}\t{h[1]}")
-
-if __name__ == "__main__":
-    main()