papi-projects 0.1.6__tar.gz → 0.1.8__tar.gz

{papi_projects-0.1.6 → papi_projects-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: papi-projects
-Version: 0.1.6
+Version: 0.1.8
 Summary: PAPI is an API for managing projects
 License: MIT
 Author: sandyjmacdonald
@@ -20,7 +20,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 Toggl Track, two 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 Asana and 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!
 
@@ -58,9 +58,14 @@ ASANA_TEAM="My Team Name"
 TOGGL_TRACK_API_KEY="YOURAPIKEY"
 TOGGL_TRACK_PASSWORD="api_token"
 TOGGL_TRACK_WORKSPACE="My Workspace Name"
+
+# Notion config
+NOTION_API_SECRET = "YOURAPISECRET"
+NOTION_CLIENTS_DB = "notionclientsdbid"
+NOTION_PROJECTS_DB = "notionprojectsdbid"
 ```
 
-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 Asana and Toggl Track accounts.
+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.
 
@@ -68,41 +73,48 @@ Alternatively, these values can be hard-coded in your scripts, but this is not a
 
 ## CLI scripts
 
-Two convenience CLI scripts are provided for common Toggl Track tasks. They are:
+Convenience CLI scripts are provided for some common tasks. They are:
 
-## create-toggl-project
+### create-toggl-project
 
 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]
+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]
 
 options:
   -h, --help            show this help message and exit
   -u USER_ID, --user_id USER_ID
-                        three-letter user ID, e.g. CRD
+                        three-letter user ID, e.g. JAS
   -g GRANT_CODE, --grant_code GRANT_CODE
                         grant code, 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-ABC-DEFG, if already generated
+                        full project ID, e.g. P2024-JAS-ABCD, if already generated
+  --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
 ```
 
 Ideally, a three-character user ID, grant code, and short project name will be provided, and PAPI will generate the project ID, e.g.
 
 ```
-create-toggl-project -u CRD -g R12345 -n 'Such project. Wow.'
+create-toggl-project -u JAS -g R12345 -n 'Such project. Wow.'
 ```
 
 If a project ID has already been created, then it can be provided via the `-p` argument and the user ID is not necessary, e.g.
 
 ```
-create-toggl-project -p P2024-CRD-ABCD -g R12345 -n 'Such project. Wow.'
+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.
 
-## collate-toggl-hours
+Logging can also be enabled at various levels of detail, and logs can be saved to a file.
+
+### collate-toggl-hours
 
 This script collates and returns your Toggl Track hours tracked over a specified time period:
 
@@ -130,11 +142,75 @@ To collate your hours worked in August 2024:
 collate-toggl-hours -s 2024-08-01 -e 2024-08-31 -o august-2024-hours.tsv
 ```
 
+### create-notion-project
+
+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]
+
+options:
+  -h, --help            show this help message and exit
+  -u USER_ID, --user_id USER_ID
+                        three-letter user (client) 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
+  -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
+  --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
+```
+
+Similar to the `create-toggl-project` script, you can simply provide a three-character user ID and a short project name, and PAPI will generate the project ID, e.g.
+
+```
+create-notion-project -u JAS -n 'Such project. Wow.'
+```
+
+If a project ID has already been created, then it can be provided via the `-p` argument and the user ID is not necessary, e.g.
+
+```
+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-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]
+                      [--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
+  -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
+  -p PROJECT_ID, --project_id PROJECT_ID
+                        full project ID, e.g. P2024-JAS-DEFG, if already generated
+  --enable-toggl        create Toggl Track project
+  --enable-notion       create Notion project
+  --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-project`, then interactive prompts are shown to enter the necessary arguments.
+
 ## API reference
 
-## project module
+### project module
 
-## Project class
+### Project class
 
 The `Project` class is central to the whole library. A `Project` instance can be created in a few different ways.
 
@@ -143,7 +219,7 @@ At the most basic level, a valid `user_id` (either three letter initials or two
 ```
 from papi.project import Project
 
-proj = Project(user_id="CRD")
+proj = Project(user_id="JAS")
 ```
 
 This will generate the project ID, `id` attribute using the current year, and a random four-letter suffix.
@@ -155,15 +231,15 @@ print(proj.suffix)
 ```
 
 ```
-P2024-CRD-FZLL
+P2024-JAS-ABCD
 2024
-FZLL
+ABCD
 ```
 
 If a valid project ID has already been created, then a `Project` instance can be instantiated with the `id` attribute, and the `year`, `user_id`, and `suffix` attributes will be pulled out and set on the instance.
 
 ```
-proj = Project(id="P2024-CRD-FZLL")
+proj = Project(id="P2024-JAS-ABCD")
 
 print(proj.year)
 print(proj.user_id)
@@ -172,20 +248,20 @@ print(proj.suffix)
 
 ```
 2024
-CRD
-FZLL
+JAS
+ABCD
 ```
 
 If a grant code and/or project name are available, then these can be passed in when instantiating the class.
 
 ```
-proj = Project(user_id="CRD", grant_code="R12345", name="RNA-seq analysis")
+proj = Project(user_id="JAS", grant_code="R12345", name="RNA-seq analysis")
 ```
 
 A version 4 UUID is also generated for the project when instantiated.
 
 ```
-proj = Project(user_id="CRD")
+proj = Project(user_id="JAS")
 
 print(proj.p_uuid)
 ```
@@ -197,10 +273,10 @@ print(proj.p_uuid)
  Or if a version 4 UUID has been generated separately then it can be provided when instantiating.
 
  ```
- proj = Project(user_id="CRD", p_uuid="6697e457-9785-4668-b78b-72616b27aede")
+ proj = Project(user_id="JAS", p_uuid="6697e457-9785-4668-b78b-72616b27aede")
  ```
 
-## project functions
+### project functions
 
 A couple of functions are provided to check the validity of a project ID, to check the validity of a suffix, and to check for a valid version 4 UUID.
 
@@ -209,8 +285,8 @@ You can check the validity of a project ID as follows:
 ```
 from papi.project import check_project_id
 
-print(check_project_id("P2024-CRD-FZLL"))
-print(check_project_id("P2024-CRD-1234"))
+print(check_project_id("P2024-JAS-ABCD"))
+print(check_project_id("P2024-JAS-1234"))
 ```
 
 ```
@@ -223,7 +299,7 @@ You can check the validity of a project suffix as follows:
 ```
 from papi.project import check_suffix
 
-print(check_suffix("FZLL"))
+print(check_suffix("ABCD"))
 print(check_suffix("1234"))
 ```
 
@@ -232,9 +308,9 @@ True
 False
 ```
 
-## user module
+### user module
 
-## User class
+### User class
 
 The `User` class stores attributes of a user: their name, a three-letter initial (or two-letter initial and integer number from 1 to 9), and an optional email address.
 
@@ -243,15 +319,15 @@ The most basic way of instantiating a `User` instance is as follows:
 ```
 from papi.user import User
 
-usr = User("Charles Robert Darwin")
+usr = User("John Andrew Smith")
 
 print(usr.user_id)
 print(usr.user_name)
 ```
 
 ```
-CRD
-Charles Robert Darwin
+JAS
+John Andrew Smith
 ```
 
 The first initials are converted into the `user_id` attribute.
@@ -261,20 +337,20 @@ If an email address is available, then this can be provided when instantiating:
 ```
 from papi.user import User
 
-usr = User("Charles Robert Darwin", email="cdarwin@beaglemail.com")
+usr = User("John Andrew Smith", email="jasmith@email.com")
 
 print(usr.email)
 ```
 
 ```
-cdarwin@beaglemail.com
+jasmith@email.com
 ```
 
 Because our user ID naming scheme enforces that a user ID must be unique, the `user_id` attribute should not really be set directly, although it can in theory:
 
 ```
-usr = User("Charles Darwin")
-usr.user_id = "CD1"
+usr = User("John Smith")
+usr.user_id = "JS1"
 ```
 
 Setting the `user_id` attribute creates the possibility of a clash in user IDs, therefore the `user` module provides a means to create a basic user database with the TinyDB library. This avoids the possibility of a clash and appends and increments integer numbers to the end of the user ID if a matching one is already in the database.

{papi_projects-0.1.6 → papi_projects-0.1.8}/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 Toggl Track, two 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 Asana and 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!
 
@@ -40,9 +40,14 @@ ASANA_TEAM="My Team Name"
 TOGGL_TRACK_API_KEY="YOURAPIKEY"
 TOGGL_TRACK_PASSWORD="api_token"
 TOGGL_TRACK_WORKSPACE="My Workspace Name"
+
+# Notion config
+NOTION_API_SECRET = "YOURAPISECRET"
+NOTION_CLIENTS_DB = "notionclientsdbid"
+NOTION_PROJECTS_DB = "notionprojectsdbid"
 ```
 
-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 Asana and Toggl Track accounts.
+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.
 
@@ -50,41 +55,48 @@ Alternatively, these values can be hard-coded in your scripts, but this is not a
 
 ## CLI scripts
 
-Two convenience CLI scripts are provided for common Toggl Track tasks. They are:
+Convenience CLI scripts are provided for some common tasks. They are:
 
-## create-toggl-project
+### create-toggl-project
 
 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]
+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]
 
 options:
   -h, --help            show this help message and exit
   -u USER_ID, --user_id USER_ID
-                        three-letter user ID, e.g. CRD
+                        three-letter user ID, e.g. JAS
   -g GRANT_CODE, --grant_code GRANT_CODE
                         grant code, 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-ABC-DEFG, if already generated
+                        full project ID, e.g. P2024-JAS-ABCD, if already generated
+  --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
 ```
 
 Ideally, a three-character user ID, grant code, and short project name will be provided, and PAPI will generate the project ID, e.g.
 
 ```
-create-toggl-project -u CRD -g R12345 -n 'Such project. Wow.'
+create-toggl-project -u JAS -g R12345 -n 'Such project. Wow.'
 ```
 
 If a project ID has already been created, then it can be provided via the `-p` argument and the user ID is not necessary, e.g.
 
 ```
-create-toggl-project -p P2024-CRD-ABCD -g R12345 -n 'Such project. Wow.'
+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.
 
-## collate-toggl-hours
+Logging can also be enabled at various levels of detail, and logs can be saved to a file.
+
+### collate-toggl-hours
 
 This script collates and returns your Toggl Track hours tracked over a specified time period:
 
@@ -112,11 +124,75 @@ To collate your hours worked in August 2024:
 collate-toggl-hours -s 2024-08-01 -e 2024-08-31 -o august-2024-hours.tsv
 ```
 
+### create-notion-project
+
+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]
+
+options:
+  -h, --help            show this help message and exit
+  -u USER_ID, --user_id USER_ID
+                        three-letter user (client) 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
+  -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
+  --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
+```
+
+Similar to the `create-toggl-project` script, you can simply provide a three-character user ID and a short project name, and PAPI will generate the project ID, e.g.
+
+```
+create-notion-project -u JAS -n 'Such project. Wow.'
+```
+
+If a project ID has already been created, then it can be provided via the `-p` argument and the user ID is not necessary, e.g.
+
+```
+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-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]
+                      [--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
+  -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
+  -p PROJECT_ID, --project_id PROJECT_ID
+                        full project ID, e.g. P2024-JAS-DEFG, if already generated
+  --enable-toggl        create Toggl Track project
+  --enable-notion       create Notion project
+  --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-project`, then interactive prompts are shown to enter the necessary arguments.
+
 ## API reference
 
-## project module
+### project module
 
-## Project class
+### Project class
 
 The `Project` class is central to the whole library. A `Project` instance can be created in a few different ways.
 
@@ -125,7 +201,7 @@ At the most basic level, a valid `user_id` (either three letter initials or two
 ```
 from papi.project import Project
 
-proj = Project(user_id="CRD")
+proj = Project(user_id="JAS")
 ```
 
 This will generate the project ID, `id` attribute using the current year, and a random four-letter suffix.
@@ -137,15 +213,15 @@ print(proj.suffix)
 ```
 
 ```
-P2024-CRD-FZLL
+P2024-JAS-ABCD
 2024
-FZLL
+ABCD
 ```
 
 If a valid project ID has already been created, then a `Project` instance can be instantiated with the `id` attribute, and the `year`, `user_id`, and `suffix` attributes will be pulled out and set on the instance.
 
 ```
-proj = Project(id="P2024-CRD-FZLL")
+proj = Project(id="P2024-JAS-ABCD")
 
 print(proj.year)
 print(proj.user_id)
@@ -154,20 +230,20 @@ print(proj.suffix)
 
 ```
 2024
-CRD
-FZLL
+JAS
+ABCD
 ```
 
 If a grant code and/or project name are available, then these can be passed in when instantiating the class.
 
 ```
-proj = Project(user_id="CRD", grant_code="R12345", name="RNA-seq analysis")
+proj = Project(user_id="JAS", grant_code="R12345", name="RNA-seq analysis")
 ```
 
 A version 4 UUID is also generated for the project when instantiated.
 
 ```
-proj = Project(user_id="CRD")
+proj = Project(user_id="JAS")
 
 print(proj.p_uuid)
 ```
@@ -179,10 +255,10 @@ print(proj.p_uuid)
  Or if a version 4 UUID has been generated separately then it can be provided when instantiating.
 
  ```
- proj = Project(user_id="CRD", p_uuid="6697e457-9785-4668-b78b-72616b27aede")
+ proj = Project(user_id="JAS", p_uuid="6697e457-9785-4668-b78b-72616b27aede")
  ```
 
-## project functions
+### project functions
 
 A couple of functions are provided to check the validity of a project ID, to check the validity of a suffix, and to check for a valid version 4 UUID.
 
@@ -191,8 +267,8 @@ You can check the validity of a project ID as follows:
 ```
 from papi.project import check_project_id
 
-print(check_project_id("P2024-CRD-FZLL"))
-print(check_project_id("P2024-CRD-1234"))
+print(check_project_id("P2024-JAS-ABCD"))
+print(check_project_id("P2024-JAS-1234"))
 ```
 
 ```
@@ -205,7 +281,7 @@ You can check the validity of a project suffix as follows:
 ```
 from papi.project import check_suffix
 
-print(check_suffix("FZLL"))
+print(check_suffix("ABCD"))
 print(check_suffix("1234"))
 ```
 
@@ -214,9 +290,9 @@ True
 False
 ```
 
-## user module
+### user module
 
-## User class
+### User class
 
 The `User` class stores attributes of a user: their name, a three-letter initial (or two-letter initial and integer number from 1 to 9), and an optional email address.
 
@@ -225,15 +301,15 @@ The most basic way of instantiating a `User` instance is as follows:
 ```
 from papi.user import User
 
-usr = User("Charles Robert Darwin")
+usr = User("John Andrew Smith")
 
 print(usr.user_id)
 print(usr.user_name)
 ```
 
 ```
-CRD
-Charles Robert Darwin
+JAS
+John Andrew Smith
 ```
 
 The first initials are converted into the `user_id` attribute.
@@ -243,20 +319,20 @@ If an email address is available, then this can be provided when instantiating:
 ```
 from papi.user import User
 
-usr = User("Charles Robert Darwin", email="cdarwin@beaglemail.com")
+usr = User("John Andrew Smith", email="jasmith@email.com")
 
 print(usr.email)
 ```
 
 ```
-cdarwin@beaglemail.com
+jasmith@email.com
 ```
 
 Because our user ID naming scheme enforces that a user ID must be unique, the `user_id` attribute should not really be set directly, although it can in theory:
 
 ```
-usr = User("Charles Darwin")
-usr.user_id = "CD1"
+usr = User("John Smith")
+usr.user_id = "JS1"
 ```
 
 Setting the `user_id` attribute creates the possibility of a clash in user IDs, therefore the `user` module provides a means to create a basic user database with the TinyDB library. This avoids the possibility of a clash and appends and increments integer numbers to the end of the user ID if a matching one is already in the database.

{papi_projects-0.1.6 → papi_projects-0.1.8}/papi/project.py

@@ -30,6 +30,16 @@ def check_project_id(id: str) -> bool:
         logger.info(f"Project ID '{id}' is not valid")
     return valid
 
+def user_id_from_project_id(id: str) -> str:
+    """Extracts a three-letter user ID from a project ID.
+
+    :param id: Project ID to use.
+    :type id: str
+    :return: Three-letter user ID.
+    :rtype: str
+    """
+    logger.debug("Calling user_id_from_project_id function")
+    return id.split("-")[1]
 
 def check_suffix(suffix: str) -> bool:
     """Checks whether a project suffix is correctly formed.

{papi_projects-0.1.6 → papi_projects-0.1.8}/papi/wrappers.py

@@ -710,7 +710,7 @@ class NotionWrapper(Protocol):
             logger.info(f"Notion user found with page ID {user_page_id}")
             return user_page_id
         else:
-            logger.warning("Notion user not found")
+            logger.info("Notion user not found")
             return None
 
     def get_users(self, clients_db_id: str) -> list:

{papi_projects-0.1.6 → papi_projects-0.1.8}/pyproject.toml

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

{papi_projects-0.1.6 → papi_projects-0.1.8}/scripts/create_notion_project.py

@@ -10,25 +10,25 @@ def main():
     # Set up argparse
     parser = argparse.ArgumentParser()
     parser.add_argument(
-        "-u", "--user_id", type=str, help="three-letter user (client) ID, e.g. JS1", required=False
+        "-u", "--user_id", type=str, help="three-letter user (client) ID, e.g. JAS", required=False
     )
     parser.add_argument(
-        "-v", "--user_name", type=str, help="user (client) name, e.g. John Smith", required=False
+        "-v", "--user_name", type=str, help="user (client) name, e.g. John Andrew Smith", required=False
     )
     parser.add_argument(
         "-n", "--name", type=str, help="short project name, e.g. 'RNA-seq analysis', project ID will be auto-generated", required=False
     )
     parser.add_argument(
-        "-p", "--project_id", type=str, help="full project ID, e.g. P2024-JS1-DEFG, if already generated", required=False
+        "-p", "--project_id", type=str, help="full project ID, e.g. P2024-JAS-ABCD, if already generated", required=False
     )
     parser.add_argument(
-        '--enable-logging', action='store_true', help='Enable logging output for the papi library.'
+        '--enable-logging', action='store_true', help='enable logging output for the papi librar.'
     )
     parser.add_argument(
-        '--log-level', type=str, choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], default='INFO', help='Set the logging level (default: INFO).'
+        '--log-level', type=str, choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], default='INFO', help='set the logging level (default: INFO)'
     )
     parser.add_argument(
-        '--log-file', type=str, help='Path to a file where logs should be written.'
+        '--log-file', type=str, help='path to a file where logs should be written'
     )
     args = parser.parse_args()
 

papi_projects-0.1.8/scripts/create_project.py

@@ -0,0 +1,171 @@
+import sys
+import argparse
+from papi.wrappers import NotionWrapper, TogglTrackWrapper
+from papi import config, setup_logger
+from papi.user import User
+from papi.project import Project, check_project_id, user_id_from_project_id
+
+def prompt_for_args():
+    """Prompt the user for input interactively."""
+    print("No command-line arguments provided. Enter the required information below:")
+    print()
+    
+    user_id = input("Enter project PI three-letter ID (e.g., JAS): ").strip()
+    if not user_id:
+        user_name = input("Enter project PI name (e.g., John Andrew Smith): ").strip()
+    else:
+        user_name = None
+    name = input("Enter project name (e.g., 'RNA-seq analysis'): ").strip()
+    if not user_id and not user_name:
+        project_id = input("Enter project ID (e.g., P2024-JAS-DEFG): ").strip()
+        if check_project_id(project_id):
+            user_id = user_id_from_project_id(project_id)
+    else:
+        project_id = None
+    
+    enable_logging_input = input("Enable logging? (y/n) [n]: ").strip().lower()
+    enable_logging = enable_logging_input in ('y', 'yes')
+    
+    if enable_logging:
+        log_level_choices = ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']
+        log_level = input(f"Set log level {log_level_choices} [INFO]: ").strip().upper()
+        log_level = log_level if log_level else None
+        if log_level is not None and log_level not in log_level_choices:
+            print("Invalid log level. Defaulting to 'INFO'.")
+            log_level = 'INFO'
+        
+        log_file = input("Path to log file (leave blank for none): ").strip()
+        log_file = log_file if log_file else None
+    else:
+        log_level = None
+        log_file = None
+    
+    enable_toggl_input = input("Create Toggl Track project? (y/n) [n]: ").strip().lower()
+    enable_toggl = enable_toggl_input in ('y', 'yes')
+
+    enable_notion_input = input("Create Notion project? (y/n) [n]: ").strip().lower()
+    enable_notion = enable_notion_input in ('y', 'yes')
+    
+    # Create a Namespace object similar to argparse's
+    return argparse.Namespace(
+        user_id=user_id or None,
+        user_name=user_name or None,
+        name=name or None,
+        project_id=project_id or None,
+        enable_logging=enable_logging,
+        log_level=log_level,
+        log_file=log_file,
+        enable_toggl=enable_toggl,
+        enable_notion=enable_notion
+    )
+
+def main():
+    """Main function of create-project script"""
+
+    # Set up argparse
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "-u", "--user_id", type=str, help="three-letter user (client) ID, e.g. JAS", required=False
+    )
+    parser.add_argument(
+        "-v", "--user_name", type=str, help="user (client) name, e.g. John Andrew Smith", required=False
+    )
+    parser.add_argument(
+        "-n", "--name", type=str, help="short project name, e.g. 'RNA-seq analysis', project ID will be auto-generated", required=False
+    )
+    parser.add_argument(
+        "-p", "--project_id", type=str, help="full project ID, e.g. P2024-JAS-DEFG, if already generated", required=False
+    )
+    parser.add_argument(
+        '--enable-toggl', action='store_true', help='create Toggl Track project'
+    )
+    parser.add_argument(
+        '--enable-notion', action='store_true', help='create Notion project'
+    )
+    parser.add_argument(
+        '--enable-logging', action='store_true', help='enable logging output for the papi library'
+    )
+    parser.add_argument(
+        '--log-level', type=str, choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], default='INFO', help='set the logging level (default: INFO)'
+    )
+    parser.add_argument(
+        '--log-file', type=str, help='path to a file where logs should be written'
+    )
+    args = parser.parse_args()
+
+    # Check if any arguments were provided
+    if len(sys.argv) == 1:
+        args = prompt_for_args()
+    else:
+        args = parser.parse_args()
+
+    logger = setup_logger(args.enable_logging, args.log_level, args.log_file)
+
+    user_id = args.user_id
+    user_name = args.user_name
+    project_name = args.name
+    project_id = args.project_id
+    enable_toggl = args.enable_toggl
+    enable_notion = args.enable_notion
+
+    if user_id and not user_name:
+        user = User(user_id=user_id)
+    elif user_name and not user_id:
+        user = User(user_name)
+    elif user_id and user_name:
+        user = User(user_name, user_id=user_id)
+    else:
+        logger.warning("Please provide either a three-letter user ID and/or user name")
+        return
+
+    if project_id and not project_name:
+        project = Project(id=project_id)
+    elif project_name and not project_id:
+        project = Project(name=project_name, user_id=user.user_id)
+    elif project_id and project_name:
+        project = Project(name=project_name, id=project_id)
+    else:
+        logger.warning("Please provide either a valid project ID and/or project name")
+        return
+
+    if enable_toggl:
+        # 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
+        if "TOGGL_TRACK_API_KEY" not in config and "TOGGL_TRACK_PASSWORD" not in config:
+            logger.warning("Please create a .env file with TOGGL_TRACK_API_KEY and TOGGL_TRACK_PASSWORD set!")
+            return
+        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)
+
+        # Create project on Toggl Track
+        toggl_proj_id = toggl.create_project(project, toggl.default_workspace_id)
+
+    if enable_notion:
+        # Set up Notion API wrapper
+        #
+        # 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:
+            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 = 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)
+        else:
+            notion_proj_id = notion.create_project(project, user, notion_projects_db)
+
+if __name__ == "__main__":
+    main()

{papi_projects-0.1.6 → papi_projects-0.1.8}/scripts/create_toggl_project.py

@@ -10,7 +10,7 @@ def main():
     # Set up argparse
     parser = argparse.ArgumentParser()
     parser.add_argument(
-        "-u", "--user_id", type=str, help="three-letter user ID, e.g. CRD", required=False
+        "-u", "--user_id", type=str, help="three-letter user ID, e.g. JAS", required=False
     )
     parser.add_argument(
         "-g", "--grant_code", type=str, help="grant code, e.g. R12345", required=False
@@ -19,16 +19,16 @@ def main():
         "-n", "--name", type=str, help="short project name, e.g. 'RNA-seq analysis'", required=False
     )
     parser.add_argument(
-        "-p", "--project_id", type=str, help="full project ID, e.g. P2024-ABC-DEFG, if already generated", required=False
+        "-p", "--project_id", type=str, help="full project ID, e.g. P2024-JAS-ABCD, if already generated", required=False
     )
     parser.add_argument(
-        '--enable-logging', action='store_true', help='Enable logging output for the papi library.'
+        '--enable-logging', action='store_true', help='enable logging output for the papi library'
     )
     parser.add_argument(
-        '--log-level', type=str, choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], default='INFO', help='Set the logging level (default: INFO).'
+        '--log-level', type=str, choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], default='INFO', help='set the logging level (default: INFO)'
     )
     parser.add_argument(
-        '--log-file', type=str, help='Path to a file where logs should be written.'
+        '--log-file', type=str, help='path to a file where logs should be written'
     )
     args = parser.parse_args()
 
@@ -81,7 +81,7 @@ def main():
     # Create project on Toggl Track
     #
     # If name and grant code were provided, then project name will
-    # look like P2024-ABC-WXYZ - RNA-seq analysis (R12345),
+    # look like P2024-JAS-ABCD - RNA-seq analysis (R12345),
     # otherwise it will just be the project ID
     toggl_proj_id = toggl.create_project(project, toggl.default_workspace_id)
 

papi_projects-0.1.6/scripts/create_project.py

@@ -1,143 +0,0 @@
-import sys
-import argparse
-from papi.wrappers import NotionWrapper, TogglTrackWrapper
-from papi import config, setup_logger
-from papi.user import User
-from papi.project import Project
-
-def prompt_for_args():
-    """Prompt the user for input interactively."""
-    print("No command-line arguments provided. Enter the required information below:")
-    
-    user_id = input("Enter user ID (e.g., JS1): ").strip()
-    user_name = input("Enter user name (e.g., John Smith): ").strip()
-    name = input("Enter project name (e.g., 'RNA-seq analysis'): ").strip()
-    project_id = input("Enter project ID (e.g., P2024-JS1-DEFG): ").strip()
-    
-    enable_logging_input = input("Enable logging? (y/n) [n]: ").strip().lower()
-    enable_logging = enable_logging_input in ('y', 'yes')
-    
-    log_level_choices = ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']
-    log_level = input(f"Set log level {log_level_choices} [INFO]: ").strip().upper()
-    if log_level not in log_level_choices:
-        print("Invalid log level. Defaulting to 'INFO'.")
-        log_level = 'INFO'
-    
-    log_file = input("Path to log file (leave blank for none): ").strip()
-    log_file = log_file if log_file else None
-    
-    # Create a Namespace object similar to argparse's
-    return argparse.Namespace(
-        user_id=user_id or None,
-        user_name=user_name or None,
-        name=name or None,
-        project_id=project_id or None,
-        enable_logging=enable_logging,
-        log_level=log_level,
-        log_file=log_file
-    )
-
-def main():
-    """Main function of create-project script"""
-
-    # Set up argparse
-    parser = argparse.ArgumentParser()
-    parser.add_argument(
-        "-u", "--user_id", type=str, help="three-letter user (client) ID, e.g. JS1", required=False
-    )
-    parser.add_argument(
-        "-v", "--user_name", type=str, help="user (client) name, e.g. John Smith", required=False
-    )
-    parser.add_argument(
-        "-n", "--name", type=str, help="short project name, e.g. 'RNA-seq analysis', project ID will be auto-generated", required=False
-    )
-    parser.add_argument(
-        "-p", "--project_id", type=str, help="full project ID, e.g. P2024-JS1-DEFG, if already generated", required=False
-    )
-    parser.add_argument(
-        '--enable-logging', action='store_true', help='Enable logging output for the papi library.'
-    )
-    parser.add_argument(
-        '--log-level', type=str, choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], default='INFO', help='Set the logging level (default: INFO).'
-    )
-    parser.add_argument(
-        '--log-file', type=str, help='Path to a file where logs should be written.'
-    )
-    args = parser.parse_args()
-
-    # Check if any arguments were provided
-    if len(sys.argv) == 1:
-        args = prompt_for_args()
-    else:
-        args = parser.parse_args()
-
-    logger = setup_logger(args.enable_logging, args.log_level, args.log_file)
-
-    # Set up Notion API wrapper
-    #
-    # 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:
-        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 = NotionWrapper(notion_api_secret)
-
-    # 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
-    if "TOGGL_TRACK_API_KEY" not in config and "TOGGL_TRACK_PASSWORD" not in config:
-        logger.warning("Please create a .env file with TOGGL_TRACK_API_KEY and TOGGL_TRACK_PASSWORD set!")
-        return
-    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)
-
-    user_id = args.user_id
-    user_name = args.user_name
-    project_name = args.name
-    project_id = args.project_id
-
-    if user_id and not user_name:
-        user = User(user_id=user_id)
-    elif user_name and not user_id:
-        user = User(user_name)
-    elif user_id and user_name:
-        user = User(user_name, user_id=user_id)
-    else:
-        logger.warning("Please provide either a three-letter user ID and/or user name")
-        return
-
-    if project_id and not project_name:
-        project = Project(id=project_id)
-    elif project_name and not project_id:
-        project = Project(name=project_name, user_id=user.user_id)
-    elif project_id and project_name:
-        project = Project(name=project_name, id=project_id)
-    else:
-        logger.warning("Please provide either a valid project ID and/or project name")
-        return
-
-    # 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)
-    else:
-        notion_proj_id = notion.create_project(project, user, notion_projects_db)
-
-    # Create project on Toggl Track
-    #
-    # If name and grant code were provided, then project name will
-    # look like P2024-ABC-WXYZ - RNA-seq analysis (R12345),
-    # otherwise it will just be the project ID
-    toggl_proj_id = toggl.create_project(project, toggl.default_workspace_id)
-
-if __name__ == "__main__":
-    main()