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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: papi-projects
-Version: 0.2.5
+Version: 0.3.0
 Summary: PAPI is an API for managing projects
 License: MIT
 Author: sandyjmacdonald
@@ -21,7 +21,7 @@ PAPI is an API for managing projects.
 
 <img src="https://imgur.com/lprJ3mP.jpg" alt="HAHA BUSINESS meme" height="250">
 
-It has functionality for creating User and Project instances, storing users in a TinyDB database, and generating project IDs in the format we use in the Data Science group (at the Bioscience Technology Facility at the University of York). It also has wrappers for Asana and Notion, and Toggl Track, tools we use for project management and time tracking, respectively.
+It has functionality for creating User and Project instances, storing users in a TinyDB database, and generating project IDs in the format we use in the Data Science group (at the Bioscience Technology Facility at the University of York). It also has wrappers for Notion and Toggl Track, tools we use for project management and time tracking, respectively.
 
 Much of the functionality is tailor-made to the way we manage projects in our group, but make of it what you will!
 
@@ -44,17 +44,11 @@ poetry install
 
 ## Environment variables
 
-The Asana and Toggl Track wrappers expect several environment variables for API keys, etc. and the best way to do this is with a .env file that can be loaded via the Python dotenv library straight into your script. The CLI scripts provided also expect these variables to be in a .env file.
+The Notion and Toggl Track wrappers expect several environment variables for API keys, etc. and the best way to do this is with a .env file that can be loaded via the Python dotenv library straight into your script. The CLI scripts provided also expect these variables to be in a .env file.
 
 The .env file should look as follows:
 
 ```
-# Asana config:
-ASANA_API_KEY="YOURAPIKEY"
-ASANA_PASSWORD=""
-ASANA_WORKSPACE="myworkspace"
-ASANA_TEAM="My Team Name"
-
 # toggl track config:
 TOGGL_TRACK_API_KEY="YOURAPIKEY"
 TOGGL_TRACK_PASSWORD="api_token"
@@ -64,10 +58,10 @@ TOGGL_TRACK_WORKSPACE="My Workspace Name"
 NOTION_API_SECRET = "YOURAPISECRET"
 NOTION_CLIENTS_DB = "notionclientsdbid"
 NOTION_PROJECTS_DB = "notionprojectsdbid"
+NOTION_TASKS_DB = "notiontasksdbid"
+NOTION_TEMPLATE_PAGE_ID = "notiontemplatepageid"
 ```
 
-The `ASANA_PASSWORD` and `TOGGL_TRACK_PASSWORD` values can be left as above, the remaining ones should be replaced with the correct values from your Notion, Asana, and Toggl Track accounts.
-
 This .env file can either be put in your working directory or in the top-level papi module folder wherever it is installed.
 
 Alternatively, these values can be hard-coded in your scripts, but this is not advised and will not work with the CLI scripts provided.
@@ -81,15 +75,14 @@ Convenience CLI scripts are provided for some common tasks. They are:
 This script creates a project ID if necessary, and adds the project to your Toggl Track:
 
 ```
-usage: create-toggl-project [-h] [-u USER_ID] [-g GRANT_CODE] [-n NAME] [-p PROJECT_ID] [--enable-logging] [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                            [--log-file LOG_FILE]
+usage: create-toggl-project [-h] [-u USER_ID] [-g WORKORDER] [-n NAME] [-p PROJECT_ID] [--enable-logging] [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--log-file LOG_FILE]
 
 options:
   -h, --help            show this help message and exit
   -u USER_ID, --user_id USER_ID
                         three-letter user ID, e.g. JAS
-  -g GRANT_CODE, --grant_code GRANT_CODE
-                        grant code, e.g. R12345
+  -g WORKORDER, --workorder WORKORDER
+                        workorder, e.g. R12345
   -n NAME, --name NAME  short project name, e.g. 'RNA-seq analysis'
   -p PROJECT_ID, --project_id PROJECT_ID
                         full project ID, e.g. P2024-JAS-ABCD, if already generated
@@ -99,7 +92,7 @@ options:
   --log-file LOG_FILE   path to a file where logs should be written
 ```
 
-Ideally, a three-character user ID, grant code, and short project name will be provided, and PAPI will generate the project ID, e.g.
+Ideally, a three-character user ID, workorder, and short project name will be provided, and PAPI will generate the project ID, e.g.
 
 ```
 create-toggl-project -u JAS -g R12345 -n 'Such project. Wow.'
@@ -111,7 +104,7 @@ If a project ID has already been created, then it can be provided via the `-p` a
 create-toggl-project -p P2024-JAS-ABCD -g R12345 -n 'Such project. Wow.'
 ```
 
-The grant code (`-g`) and name (`-n`) are not required, but either a project ID (`-p`) or user ID (`-u`) _is_ necessary.
+The workorder (`-g`) and name (`-n`) are not required, but either a project ID (`-p`) or user ID (`-u`) _is_ necessary.
 
 Logging can also be enabled at various levels of detail, and logs can be saved to a file.
 
@@ -148,8 +141,8 @@ collate-toggl-hours -s 2024-08-01 -e 2024-08-31 -o august-2024-hours.tsv
 This script creates a project ID if necessary, and adds the project to the Notion projects database:
 
 ```
-usage: create-notion-project [-h] [-u USER_ID] [-v USER_NAME] [-n NAME] [-p PROJECT_ID] [--enable-logging] [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                             [--log-file LOG_FILE]
+usage: create-notion-project [-h] [-u USER_ID] [-v USER_NAME] [-n NAME] [-p PROJECT_ID] [--no-default-workorder-task] [--enable-logging]
+                             [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--log-file LOG_FILE]
 
 options:
   -h, --help            show this help message and exit
@@ -160,7 +153,9 @@ options:
   -n NAME, --name NAME  short project name, e.g. 'RNA-seq analysis', project ID will be auto-generated
   -p PROJECT_ID, --project_id PROJECT_ID
                         full project ID, e.g. P2024-JAS-ABCD, if already generated
-  --enable-logging      enable logging output for the papi library
+  --no-default-workorder-task
+                        do not add default workorder task
+  --enable-logging      enable logging output for the papi library.
   --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
                         set the logging level (default: INFO)
   --log-file LOG_FILE   path to a file where logs should be written
@@ -180,23 +175,46 @@ create-notion-project -p P2024-JAS-ABCD -n 'Such project. Wow.'
 
 Logging can also be enabled at various levels of detail, and logs can be saved to a file.
 
+### create-notion-task
+
+This script adds a task to a Notion project, and expects an existing (in Notion) project ID and task name to be passed in:
+
+```
+usage: create-notion-task [-h] [-t TASK_NAME] [-p PROJECT_ID] [--enable-logging] [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--log-file LOG_FILE]
+
+options:
+  -h, --help            show this help message and exit
+  -t TASK_NAME, --task_name TASK_NAME
+                        task name (e.g., 'Run Seqera QC pipeline')
+  -p PROJECT_ID, --project_id PROJECT_ID
+                        full project ID, e.g. P2024-JAS-DEFG
+  --enable-logging      enable logging output for the papi library
+  --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
+                        set the logging level (default: INFO)
+  --log-file LOG_FILE   path to a file where logs should be written
+```
+
+If no arguments are given to the script, i.e. just running `create-notion-task`, then interactive prompts are shown to enter the necessary arguments.
+
 ### create-project
 
 This script can create a project on Toggl Track or Notion, or both:
 
 ```
-usage: create-project [-h] [-u USER_ID] [-v USER_NAME] [-n NAME] [-p PROJECT_ID] [--enable-toggl] [--enable-notion] [--enable-logging]
+usage: create-project [-h] [-u USER_ID] [-v USER_NAME] [-n NAME] [-p PROJECT_ID] [--no-default-workorder-task] [--enable-toggl] [--enable-notion] [--enable-logging]
                       [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--log-file LOG_FILE]
 
 options:
   -h, --help            show this help message and exit
   -u USER_ID, --user_id USER_ID
-                        three-letter user (client) ID, e.g. JAS
+                        three-letter user ID, e.g. JAS
   -v USER_NAME, --user_name USER_NAME
-                        user (client) name, e.g. John Andrew Smith
-  -n NAME, --name NAME  short project name, e.g. 'RNA-seq analysis', project ID will be auto-generated
+                        user name, e.g. John Andrew Smith
+  -n NAME, --name NAME  short project name, e.g. 'RNA-seq analysis'
   -p PROJECT_ID, --project_id PROJECT_ID
-                        full project ID, e.g. P2024-JAS-DEFG, if already generated
+                        full project ID, e.g. P2024-JAS-DEFG
+  --no-default-workorder-task
+                        do not add default workorder task
   --enable-toggl        create Toggl Track project
   --enable-notion       create Notion project
   --enable-logging      enable logging output for the papi library
@@ -253,10 +271,10 @@ JAS
 ABCD
 ```
 
-If a grant code and/or project name are available, then these can be passed in when instantiating the class.
+If a workorder and/or project name are available, then these can be passed in when instantiating the class.
 
 ```
-proj = Project(user_id="JAS", grant_code="R12345", name="RNA-seq analysis")
+proj = Project(user_id="JAS", workorder="R12345", name="RNA-seq analysis")
 ```
 
 A version 4 UUID is also generated for the project when instantiated.

{papi_projects-0.2.5 → papi_projects-0.3.0}/README.md

@@ -2,7 +2,7 @@ PAPI is an API for managing projects.
 
 <img src="https://imgur.com/lprJ3mP.jpg" alt="HAHA BUSINESS meme" height="250">
 
-It has functionality for creating User and Project instances, storing users in a TinyDB database, and generating project IDs in the format we use in the Data Science group (at the Bioscience Technology Facility at the University of York). It also has wrappers for Asana and Notion, and Toggl Track, tools we use for project management and time tracking, respectively.
+It has functionality for creating User and Project instances, storing users in a TinyDB database, and generating project IDs in the format we use in the Data Science group (at the Bioscience Technology Facility at the University of York). It also has wrappers for Notion and Toggl Track, tools we use for project management and time tracking, respectively.
 
 Much of the functionality is tailor-made to the way we manage projects in our group, but make of it what you will!
 
@@ -25,17 +25,11 @@ poetry install
 
 ## Environment variables
 
-The Asana and Toggl Track wrappers expect several environment variables for API keys, etc. and the best way to do this is with a .env file that can be loaded via the Python dotenv library straight into your script. The CLI scripts provided also expect these variables to be in a .env file.
+The Notion and Toggl Track wrappers expect several environment variables for API keys, etc. and the best way to do this is with a .env file that can be loaded via the Python dotenv library straight into your script. The CLI scripts provided also expect these variables to be in a .env file.
 
 The .env file should look as follows:
 
 ```
-# Asana config:
-ASANA_API_KEY="YOURAPIKEY"
-ASANA_PASSWORD=""
-ASANA_WORKSPACE="myworkspace"
-ASANA_TEAM="My Team Name"
-
 # toggl track config:
 TOGGL_TRACK_API_KEY="YOURAPIKEY"
 TOGGL_TRACK_PASSWORD="api_token"
@@ -45,10 +39,10 @@ TOGGL_TRACK_WORKSPACE="My Workspace Name"
 NOTION_API_SECRET = "YOURAPISECRET"
 NOTION_CLIENTS_DB = "notionclientsdbid"
 NOTION_PROJECTS_DB = "notionprojectsdbid"
+NOTION_TASKS_DB = "notiontasksdbid"
+NOTION_TEMPLATE_PAGE_ID = "notiontemplatepageid"
 ```
 
-The `ASANA_PASSWORD` and `TOGGL_TRACK_PASSWORD` values can be left as above, the remaining ones should be replaced with the correct values from your Notion, Asana, and Toggl Track accounts.
-
 This .env file can either be put in your working directory or in the top-level papi module folder wherever it is installed.
 
 Alternatively, these values can be hard-coded in your scripts, but this is not advised and will not work with the CLI scripts provided.
@@ -62,15 +56,14 @@ Convenience CLI scripts are provided for some common tasks. They are:
 This script creates a project ID if necessary, and adds the project to your Toggl Track:
 
 ```
-usage: create-toggl-project [-h] [-u USER_ID] [-g GRANT_CODE] [-n NAME] [-p PROJECT_ID] [--enable-logging] [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                            [--log-file LOG_FILE]
+usage: create-toggl-project [-h] [-u USER_ID] [-g WORKORDER] [-n NAME] [-p PROJECT_ID] [--enable-logging] [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--log-file LOG_FILE]
 
 options:
   -h, --help            show this help message and exit
   -u USER_ID, --user_id USER_ID
                         three-letter user ID, e.g. JAS
-  -g GRANT_CODE, --grant_code GRANT_CODE
-                        grant code, e.g. R12345
+  -g WORKORDER, --workorder WORKORDER
+                        workorder, e.g. R12345
   -n NAME, --name NAME  short project name, e.g. 'RNA-seq analysis'
   -p PROJECT_ID, --project_id PROJECT_ID
                         full project ID, e.g. P2024-JAS-ABCD, if already generated
@@ -80,7 +73,7 @@ options:
   --log-file LOG_FILE   path to a file where logs should be written
 ```
 
-Ideally, a three-character user ID, grant code, and short project name will be provided, and PAPI will generate the project ID, e.g.
+Ideally, a three-character user ID, workorder, and short project name will be provided, and PAPI will generate the project ID, e.g.
 
 ```
 create-toggl-project -u JAS -g R12345 -n 'Such project. Wow.'
@@ -92,7 +85,7 @@ If a project ID has already been created, then it can be provided via the `-p` a
 create-toggl-project -p P2024-JAS-ABCD -g R12345 -n 'Such project. Wow.'
 ```
 
-The grant code (`-g`) and name (`-n`) are not required, but either a project ID (`-p`) or user ID (`-u`) _is_ necessary.
+The workorder (`-g`) and name (`-n`) are not required, but either a project ID (`-p`) or user ID (`-u`) _is_ necessary.
 
 Logging can also be enabled at various levels of detail, and logs can be saved to a file.
 
@@ -129,8 +122,8 @@ collate-toggl-hours -s 2024-08-01 -e 2024-08-31 -o august-2024-hours.tsv
 This script creates a project ID if necessary, and adds the project to the Notion projects database:
 
 ```
-usage: create-notion-project [-h] [-u USER_ID] [-v USER_NAME] [-n NAME] [-p PROJECT_ID] [--enable-logging] [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                             [--log-file LOG_FILE]
+usage: create-notion-project [-h] [-u USER_ID] [-v USER_NAME] [-n NAME] [-p PROJECT_ID] [--no-default-workorder-task] [--enable-logging]
+                             [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--log-file LOG_FILE]
 
 options:
   -h, --help            show this help message and exit
@@ -141,7 +134,9 @@ options:
   -n NAME, --name NAME  short project name, e.g. 'RNA-seq analysis', project ID will be auto-generated
   -p PROJECT_ID, --project_id PROJECT_ID
                         full project ID, e.g. P2024-JAS-ABCD, if already generated
-  --enable-logging      enable logging output for the papi library
+  --no-default-workorder-task
+                        do not add default workorder task
+  --enable-logging      enable logging output for the papi library.
   --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
                         set the logging level (default: INFO)
   --log-file LOG_FILE   path to a file where logs should be written
@@ -161,23 +156,46 @@ create-notion-project -p P2024-JAS-ABCD -n 'Such project. Wow.'
 
 Logging can also be enabled at various levels of detail, and logs can be saved to a file.
 
+### create-notion-task
+
+This script adds a task to a Notion project, and expects an existing (in Notion) project ID and task name to be passed in:
+
+```
+usage: create-notion-task [-h] [-t TASK_NAME] [-p PROJECT_ID] [--enable-logging] [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--log-file LOG_FILE]
+
+options:
+  -h, --help            show this help message and exit
+  -t TASK_NAME, --task_name TASK_NAME
+                        task name (e.g., 'Run Seqera QC pipeline')
+  -p PROJECT_ID, --project_id PROJECT_ID
+                        full project ID, e.g. P2024-JAS-DEFG
+  --enable-logging      enable logging output for the papi library
+  --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
+                        set the logging level (default: INFO)
+  --log-file LOG_FILE   path to a file where logs should be written
+```
+
+If no arguments are given to the script, i.e. just running `create-notion-task`, then interactive prompts are shown to enter the necessary arguments.
+
 ### create-project
 
 This script can create a project on Toggl Track or Notion, or both:
 
 ```
-usage: create-project [-h] [-u USER_ID] [-v USER_NAME] [-n NAME] [-p PROJECT_ID] [--enable-toggl] [--enable-notion] [--enable-logging]
+usage: create-project [-h] [-u USER_ID] [-v USER_NAME] [-n NAME] [-p PROJECT_ID] [--no-default-workorder-task] [--enable-toggl] [--enable-notion] [--enable-logging]
                       [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--log-file LOG_FILE]
 
 options:
   -h, --help            show this help message and exit
   -u USER_ID, --user_id USER_ID
-                        three-letter user (client) ID, e.g. JAS
+                        three-letter user ID, e.g. JAS
   -v USER_NAME, --user_name USER_NAME
-                        user (client) name, e.g. John Andrew Smith
-  -n NAME, --name NAME  short project name, e.g. 'RNA-seq analysis', project ID will be auto-generated
+                        user name, e.g. John Andrew Smith
+  -n NAME, --name NAME  short project name, e.g. 'RNA-seq analysis'
   -p PROJECT_ID, --project_id PROJECT_ID
-                        full project ID, e.g. P2024-JAS-DEFG, if already generated
+                        full project ID, e.g. P2024-JAS-DEFG
+  --no-default-workorder-task
+                        do not add default workorder task
   --enable-toggl        create Toggl Track project
   --enable-notion       create Notion project
   --enable-logging      enable logging output for the papi library
@@ -234,10 +252,10 @@ JAS
 ABCD
 ```
 
-If a grant code and/or project name are available, then these can be passed in when instantiating the class.
+If a workorder and/or project name are available, then these can be passed in when instantiating the class.
 
 ```
-proj = Project(user_id="JAS", grant_code="R12345", name="RNA-seq analysis")
+proj = Project(user_id="JAS", workorder="R12345", name="RNA-seq analysis")
 ```
 
 A version 4 UUID is also generated for the project when instantiated.

{papi_projects-0.2.5 → papi_projects-0.3.0}/papi/__init__.py

@@ -5,15 +5,14 @@ from dotenv import dotenv_values
 dotenv_path = os.path.join(os.path.dirname(__file__), '.env')
 config = dotenv_values(dotenv_path)
 
-ASANA_API_KEY = config["ASANA_API_KEY"]
-ASANA_PASSWORD = config["ASANA_PASSWORD"]
-
 TOGGL_TRACK_API_KEY = config["TOGGL_TRACK_API_KEY"]
 TOGGL_TRACK_PASSWORD = config["TOGGL_TRACK_PASSWORD"]
 
 NOTION_API_SECRET = config["NOTION_API_SECRET"]
 NOTION_CLIENTS_DB = config["NOTION_CLIENTS_DB"]
 NOTION_PROJECTS_DB = config["NOTION_PROJECTS_DB"]
+NOTION_TASKS_DB = config["NOTION_TASKS_DB"]
+NOTION_TEMPLATE_PAGE_ID = config["NOTION_TEMPLATE_PAGE_ID"]
 
 def setup_logger(enable_logging: bool, log_level: str = 'INFO', log_file: str = None):
     logger = logging.getLogger('papi')

{papi_projects-0.2.5 → papi_projects-0.3.0}/papi/project.py

@@ -40,7 +40,7 @@ def get_project_ids(project_names) -> list:
 
 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.
+    to split out a project ID, name, and workorder.
 
     :param project_name: A project name string.
     :type project_name: str
@@ -54,7 +54,7 @@ def decompose_project_name(project_name) -> dict:
         (?:\s*[-–—]\s*|\s+)?
         (?P<project_name>[^()\[\]]+?)?
         (?:\s*[\(\[]\s*
-            (?P<grant_code>[^)\]]+)
+            (?P<workorder>[^)\]]+)
         \s*[\)\]])?
         $
     """
@@ -63,17 +63,17 @@ def decompose_project_name(project_name) -> dict:
     if match:
         project_id = match.group('project_id')
         project_name = match.group('project_name')
-        grant_code = match.group('grant_code')
+        workorder = match.group('workorder')
         return {
             "project_id": project_id,
             "project_name": project_name,
-            "grant_code": grant_code
+            "workorder": workorder
         }
     else:
         return {
             "project_id": None,
             "project_name": None,
-            "grant_code": None
+            "workorder": None
         }
 
 def check_project_id(id: str) -> bool:
@@ -147,27 +147,48 @@ class Project(Protocol):
     """This class represents a project and all of its associated metadata.
 
     :param year: Year associated with the project. If no year is supplied, then the current
-        year will be used, defaults to THIS_YEAR
+        year will be used.
     :type year: int, optional
     :param user_id: User ID associated with project. Must be a valid user ID, i.e. either
         3 uppercase alphabetical initials, or 2 uppercase alphabetical initials followed
-        by a positive integer number, defaults to None
+        by a positive integer number.
     :type user_id: str, optional
     :param suffix: Project suffix; a 4-character, random, uppercase, alphabetical suffix.
-        If not supplied, then this will be auto-generated, defaults to None
+        If not supplied, then this will be auto-generated.
     :type suffix: str, optional
     :param id: Fully-formed project ID that can be supplied directly, assuming it is valid.
         A valid project ID is of the form P2024-ABC-WXYZ where 2024 is the year associated
         with the project, ABC is a valid 3-character user ID, and WXYZ is a valid 4-character
-        alphabetical suffix, defaults to None
+        alphabetical suffix.
     :type id: str, optional
     :param p_uuid: A valid version 4 UUID that can be supplied directly. If not supplied, then
-        this will be auto-generated, defaults to None
+        this will be auto-generated.
     :type p_uuid: str, optional
     :param name: A short, descriptive project name, e.g. "Mouse long-read RNA-seq analysis".
-        If not supplied, then this will be left as an empty string, defaults to ""
+        If not supplied, defaults to an empty string.
     :type name: str, optional
-    :raises TypeError: If fully-formed project ID "id" is malformed, then a TypeError is raised.
+    :param workorder: Internal work order number or code associated with the project.
+        If not supplied, defaults to None.
+    :type workorder: str, optional
+    :param created_at: Timestamp when the project was created.
+        If not supplied, defaults to None.
+    :type created_at: datetime or str, optional
+    :param modified_at: Timestamp when the project was last modified.
+        If not supplied, defaults to None.
+    :type modified_at: datetime or str, optional
+    :param status: Current status of the project, matching the Notion Status options
+        (e.g. "Not Started", "In Progress", "On Hold", "Completed").
+    :type status: str, optional
+    :param priority: Project priority level, matching the Notion Priority options
+        (e.g. "Low", "Medium", "High", "Critical").
+    :type priority: str, optional
+    :param owner: List of owners of the project.
+        If not supplied, defaults to None.
+    :type owner: list[str], optional
+    :param notion_page_id: The internal Notion page UUID for this project record.
+        If not supplied, defaults to None.
+    :type notion_page_id: str, optional
+    :raises TypeError: If the fully-formed project ID `id` is malformed.
     """
 
     def __init__(
@@ -178,18 +199,28 @@ class Project(Protocol):
         id: str = None,
         p_uuid: str = None,
         name: str = "",
-        grant_code: str = None,
+        workorder: str = None,
         created_at = None,
         modified_at = None,
+        status: str = None,
+        priority: str = None,
+        owner: list = None,
+        tasks: list = None,
+        notion_page_id: str = None
     ) -> None:
         """Constructor method"""
         logger.debug("Creating Project instance")
         self.year = year
         self.user_id = user_id
-        self.grant_code = grant_code
+        self.workorder = workorder
         self.name = name
         self.created_at = created_at
         self.modified_at = modified_at
+        self.status = status
+        self.priority = priority
+        self.owner = owner
+        self.tasks = tasks
+        self.notion_page_id = notion_page_id
         if suffix is not None:
             self.suffix = suffix
         else:
@@ -207,7 +238,7 @@ class Project(Protocol):
             self.id = f"P{self.year}-{self.user_id}-{self.suffix}"
         else:
             raise TypeError(
-                "ID is incorrectly formed, must similar to P2024-ABC-DEFG or P2024-AB1-DEFG"
+                f"ID '{id}' is incorrectly formed, must similar to P2024-ABC-DEFG or P2024-AB1-DEFG"
             )
         if p_uuid is not None and check_uuid(p_uuid):
             self.p_uuid = p_uuid
@@ -220,14 +251,25 @@ class Project(Protocol):
             self.p_uuid = str(uuid.uuid4())
         logger.info(f"Project '{self.id}' instance created")
 
-    def __repr__(self) -> str:
+    def __str__(self) -> str:
         """Machine-readable representation of class..
 
         :return: basic Project() attrs.
         :rtype: str
         """
-        logger.debug("Calling Project.__repr__ method")
-        return f'Project("{self.id}", "{self.name}")'
+        logger.debug("Calling Project.__str__ method")
+        return (
+            f"Project(\n"
+            f"    id = {self.id},\n"
+            f"    name = {self.name},\n"
+            f"    year = {self.year},\n"
+            f"    user_id = {self.user_id},\n"
+            f"    priority = {self.priority}\n"
+            f"    status = {self.status}\n"
+            f"    owner = {self.owner}\n"
+            f"    notion_page_id = {self.notion_page_id}\n"
+            f")"
+        )
 
     def generate_suffix(self) -> str:
         """Generates a 4-character, uppercase, alphabetical suffix for a project, and

papi_projects-0.3.0/papi/task.py

@@ -0,0 +1,66 @@
+import warnings
+import logging
+from typing import Protocol, runtime_checkable
+
+logger = logging.getLogger(__name__)
+
+@runtime_checkable
+class Task(Protocol):
+    """This class represents a task and all of its associated metadata.
+
+    :param name: A short, descriptive task name, e.g. "Sort gene annotations".
+        If not supplied, defaults to None.
+    :type name: str, optional
+    :param project_id: The Project ID of the Project that this task belongs to.
+        Should match an existing Project ID, defaults to None.
+    :type project_id: str, optional
+    :param status: The status of the task, matching one of your Notion Status options
+        (e.g. "Not started", "In progress", "Completed"), defaults to None.
+    :type status: str, optional
+    :param priority: The priority level of the task, matching one of your Notion Select
+        options (e.g. "Low", "Standard", "Urgent"), defaults to None.
+    :type priority: str, optional
+    :param assigned_to: The name of the person assigned to the task.
+        Should correspond to a valid Notion user name, defaults to None.
+    :type assigned_to: str, optional
+    :param notion_page_id: The internal Notion page UUID for this task record.
+    :type notion_page_id: str, optional
+    """
+
+    def __init__(
+        self,
+        name: str = None,
+        project_id: str = None,
+        status: str = None,
+        priority: str = "Standard",
+        assigned_to: str = None,
+        notion_page_id: str = None
+    ) -> None:
+        """Constructor method"""
+        logger.debug("Creating Task instance")
+        self.name = name
+        self.project_id = project_id
+        self.status = status
+        self.priority = priority
+        self.assigned_to = assigned_to
+        self.notion_page_id = notion_page_id
+
+        logger.info(f"Task: '{self.name} ({self.project_id})' instance created")
+
+    def __str__(self) -> str:
+        """Machine-readable representation of class..
+
+        :return: basic Task() attrs.
+        :rtype: str
+        """
+        logger.debug("Calling Task.__str__ method")
+        return (
+            f"Task(\n"
+            f"    name = {self.name},\n"
+            f"    project_id = {self.project_id},\n"
+            f"    status = {self.status},\n"
+            f"    priority = {self.priority},\n"
+            f"    assigned_to = {self.assigned_to},\n"
+            f"    notion_page_id = {self.notion_page_id}\n"
+            f")"
+        )