papi-projects 0.1.9__tar.gz → 0.2.0__tar.gz

{papi_projects-0.1.9 → papi_projects-0.2.0}/PKG-INFO

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

{papi_projects-0.1.9 → papi_projects-0.2.0}/papi/project.py

@@ -12,6 +12,70 @@ logger = logging.getLogger(__name__)
 
 THIS_YEAR = pendulum.now().year
 
+
+def get_project_ids(project_names) -> list:
+    """This function takes a list of project names and finds and
+    returns a list of project IDs.
+
+    :param project_names: A list of project names.
+    :type project_names: list
+    :return: A list of project IDs.
+    :rtype: list
+    """
+    logger.debug("Calling get_project_ids function")
+    project_ids = []
+    project_id_pattern = r"P[0-9]{4}-[A-Z]{2}[A-Z0-9]{1}-[A-Z]{4}"
+    for project_name in project_names:
+        match = re.search(project_id_pattern, project_name)
+        if match:
+            project_id = match.group()
+            if project_id not in project_ids:
+                project_ids.append(project_id)
+    project_ids = sorted(project_ids)
+    if len(project_ids):
+        logger.info(f"{len(project_ids)} project IDs found")
+    else:
+        logger.info(f"No project IDs found")
+    return project_ids
+
+def decompose_project_name(project_name) -> dict:
+    """This function takes a project name string and attempts
+    to split out a project ID, name, and grant code.
+
+    :param project_name: A project name string.
+    :type project_name: str
+    :return: A dictionary with the split-out parts.
+    :rtype: dict
+    """
+    logger.debug("Calling decompose_project_name function")
+    pattern = r"""
+        ^
+        (?P<project_id>P\d{4}-(?:[A-Z]{2}\d|[A-Z]{3})-[A-Z]{4})?
+        (?:\s*[-–—]\s*|\s+)?
+        (?P<project_name>[^()\[\]]+?)?
+        (?:\s*[\(\[]\s*
+            (?P<grant_code>[^)\]]+)
+        \s*[\)\]])?
+        $
+    """
+    regex = re.compile(pattern, re.VERBOSE)
+    match = regex.match(project_name)
+    if match:
+        project_id = match.group('project_id')
+        project_name = match.group('project_name')
+        grant_code = match.group('grant_code')
+        return {
+            "project_id": project_id,
+            "project_name": project_name,
+            "grant_code": grant_code
+        }
+    else:
+        return {
+            "project_id": None,
+            "project_name": None,
+            "grant_code": None
+        }
+
 def check_project_id(id: str) -> bool:
     """Checks whether a project ID is correctly formed.
 
@@ -115,6 +179,8 @@ class Project(Protocol):
         p_uuid: str = None,
         name: str = "",
         grant_code: str = None,
+        created_at = None,
+        modified_at = None,
     ) -> None:
         """Constructor method"""
         logger.debug("Creating Project instance")
@@ -122,6 +188,8 @@ class Project(Protocol):
         self.user_id = user_id
         self.grant_code = grant_code
         self.name = name
+        self.created_at = created_at
+        self.modified_at = modified_at
         if suffix is not None:
             self.suffix = suffix
         else:

{papi_projects-0.1.9 → papi_projects-0.2.0}/papi/user.py

@@ -184,7 +184,7 @@ class UserDB(Protocol):
                 else:
                     user.user_id = f"{first_last_initial}1"
         self.db.insert(user.to_json())
-        logger.info(f"User ID '{useruser_id}' inserted into user database")
+        logger.info(f"User ID '{user.user_id}' inserted into user database")
         return user.user_id
 
     def search_by_user_name(self, user_name: str) -> list:

{papi_projects-0.1.9 → papi_projects-0.2.0}/papi/wrappers.py

@@ -6,36 +6,11 @@ import pendulum
 import warnings
 import logging
 from typing import Protocol, runtime_checkable
-from papi.project import Project
+from papi.project import Project, get_project_ids, decompose_project_name
 from papi.user import User
 
 logger = logging.getLogger(__name__)
 
-def get_project_ids(project_names):
-    """This function takes a list of project names and finds and
-    returns a list of project IDs.
-
-    :param project_names: A list of project names.
-    :type project_names: list
-    :return: A list of project IDs.
-    :rtype: list
-    """
-    logger.debug("Calling get_project_ids function")
-    project_ids = []
-    project_id_pattern = r"P[0-9]{4}-[A-Z]{2}[A-Z0-9]{1}-[A-Z]{4}"
-    for project_name in project_names:
-        match = re.search(project_id_pattern, project_name)
-        if match:
-            project_id = match.group()
-            if project_id not in project_ids:
-                project_ids.append(project_id)
-    project_ids = sorted(project_ids)
-    if len(project_ids):
-        logger.info(f"{len(project_ids)} project IDs found")
-    else:
-        logger.info(f"No project IDs found")
-    return project_ids
-
 
 @runtime_checkable
 class AsanaWrapper(Protocol):
@@ -433,6 +408,29 @@ class TogglTrackWrapper(Protocol):
         r = client.get("https://api.track.toggl.com/api/v9/me/projects")
         r_json = r.json()
         return r_json
+    
+    def get_user_project_objects(self) -> list:
+        """Gets all of the Toggl Track user's projects as Project instances.
+
+        :return: A list of Project instances.
+        :rtype: dict
+        """
+        logger.debug("Calling TogglTrackWrapper.get_user_project_objects method")
+        user_projects_json = self.get_user_projects()
+        user_project_names = [p["name"] for p in user_projects_json]
+        user_project_created = [pendulum.parse(p["created_at"]) for p in user_projects_json]
+        user_project_modified = [pendulum.parse(p["at"]) for p in user_projects_json]
+        user_projects = []
+        for i, n in enumerate(user_project_names):
+            decomposed = decompose_project_name(n)
+            if decomposed["project_id"] is not None:
+                project_id = decomposed["project_id"]
+                project_name = decomposed["project_name"]
+                created_at = user_project_created[i]
+                modified_at = user_project_modified[i]
+                project = Project(id=project_id, name=project_name, created_at=created_at, modified_at=modified_at)
+                user_projects.append(project)
+        return user_projects
 
     def get_user_hours(
         self, start_time=None, end_time=pendulum.now().to_rfc3339_string()
@@ -509,6 +507,29 @@ class TogglTrackWrapper(Protocol):
         user_ids = sorted(list(set([pid.split("-")[1] for pid in project_ids])))
         return user_ids
 
+    def get_workspace_project_objects(self) -> list:
+        """Gets all of the Toggl Track workspace's projects as Project instances.
+
+        :return: A list of Project instances.
+        :rtype: dict
+        """
+        logger.debug("Calling TogglTrackWrapper.get_workspace_project_objects method")
+        workspace_projects_json = self.get_workspace_projects()
+        workspace_project_names = [p["name"] for p in workspace_projects_json]
+        workspace_projects = []
+        workspace_project_created = [pendulum.parse(p["created_at"]) for p in workspace_projects_json]
+        workspace_project_modified = [pendulum.parse(p["at"]) for p in workspace_projects_json]
+        for i, n in enumerate(workspace_project_names):
+            decomposed = decompose_project_name(n)
+            if decomposed["project_id"] is not None:
+                project_id = decomposed["project_id"]
+                project_name = decomposed["project_name"]
+                created_at = workspace_project_created[i]
+                modified_at = workspace_project_modified[i]
+                project = Project(id=project_id, name=project_name, created_at=created_at, modified_at=modified_at)
+                workspace_projects.append(project)
+        return workspace_projects
+
     def check_project_exists(self, id: str) -> str:
         """Checks whether a Toggl Track project containing the specified
         project ID already exists. If a name containing that ID is found,

{papi_projects-0.1.9 → papi_projects-0.2.0}/pyproject.toml

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

{papi_projects-0.1.9 → papi_projects-0.2.0}/scripts/collate_toggl_hours.py

@@ -48,18 +48,19 @@ def main():
     # 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 t in tracked_hours:
-                out.write(f"{projects[t]}\t{tracked_hours[t]}\n")
+            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 t in tracked_hours:
-            print(f"{projects[t]}\t{tracked_hours[t]}")
+        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()

{papi_projects-0.1.9 → papi_projects-0.2.0}/scripts/create_toggl_project.py

@@ -1,5 +1,4 @@
 import argparse
-import warnings
 from papi.wrappers import TogglTrackWrapper
 from papi import config, setup_logger
 from papi.project import Project