papi-projects 0.1.2__tar.gz → 0.1.4__tar.gz

{papi_projects-0.1.2 → papi_projects-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: papi-projects
-Version: 0.1.2
+Version: 0.1.4
 Summary: PAPI is an API for managing projects
 License: MIT
 Author: sandyjmacdonald
@@ -18,6 +18,8 @@ Description-Content-Type: text/markdown
 
 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.
 
 Much of the functionality is tailor-made to the way we manage projects in our group, but make of it what you will!
@@ -127,3 +129,101 @@ To collate your hours worked in August 2024:
 ```
 collate-toggl-hours -s 2024-08-01 -e 2024-08-31 -o august-2024-hours.tsv
 ```
+
+## API reference
+
+## project module
+
+## Project class
+
+The `Project` class is central to the whole library. A `Project` instance can be created in a few different ways.
+
+At the most basic level, a valid `user_id` (either three letter initials or two letter initials and an integer number from 1 to 9) can be provided when instantiating the class, and the prefix and suffix will be generated.
+
+```
+from papi.project import Project
+
+proj = Project(user_id="CRD")
+```
+
+This will generate the project ID, `id` attribute using the current year, and a random four-letter suffix.
+
+```
+print(proj.id)
+print(proj.year)
+print(proj.suffix)
+```
+
+```
+P2024-CRD-FZLL
+2024
+FZLL
+```
+
+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")
+
+print(proj.year)
+print(proj.user_id)
+print(proj.suffix)
+```
+
+```
+2024
+CRD
+FZLL
+```
+
+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")
+```
+
+A version 4 UUID is also generated for the project when instantiated.
+
+```
+proj = Project(user_id="CRD")
+
+print(proj.p_uuid)
+```
+
+```
+6697e457-9785-4668-b78b-72616b27aede
+```
+
+ 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")
+ ```
+
+## 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.
+
+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"))
+```
+
+```
+True
+False
+```
+
+You can check the validity of a project suffix as follows:
+
+```
+from papi.project import check_suffix
+
+print(check_suffix("FZLL"))
+print(check_suffix("1234"))
+```
+

{papi_projects-0.1.2 → papi_projects-0.1.4}/README.md

@@ -1,5 +1,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.
 
 Much of the functionality is tailor-made to the way we manage projects in our group, but make of it what you will!
@@ -108,4 +110,101 @@ To collate your hours worked in August 2024:
 
 ```
 collate-toggl-hours -s 2024-08-01 -e 2024-08-31 -o august-2024-hours.tsv
-```
+```
+
+## API reference
+
+## project module
+
+## Project class
+
+The `Project` class is central to the whole library. A `Project` instance can be created in a few different ways.
+
+At the most basic level, a valid `user_id` (either three letter initials or two letter initials and an integer number from 1 to 9) can be provided when instantiating the class, and the prefix and suffix will be generated.
+
+```
+from papi.project import Project
+
+proj = Project(user_id="CRD")
+```
+
+This will generate the project ID, `id` attribute using the current year, and a random four-letter suffix.
+
+```
+print(proj.id)
+print(proj.year)
+print(proj.suffix)
+```
+
+```
+P2024-CRD-FZLL
+2024
+FZLL
+```
+
+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")
+
+print(proj.year)
+print(proj.user_id)
+print(proj.suffix)
+```
+
+```
+2024
+CRD
+FZLL
+```
+
+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")
+```
+
+A version 4 UUID is also generated for the project when instantiated.
+
+```
+proj = Project(user_id="CRD")
+
+print(proj.p_uuid)
+```
+
+```
+6697e457-9785-4668-b78b-72616b27aede
+```
+
+ 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")
+ ```
+
+## 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.
+
+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"))
+```
+
+```
+True
+False
+```
+
+You can check the validity of a project suffix as follows:
+
+```
+from papi.project import check_suffix
+
+print(check_suffix("FZLL"))
+print(check_suffix("1234"))
+```

{papi_projects-0.1.2 → papi_projects-0.1.4}/papi/__init__.py

@@ -1,6 +1,8 @@
+import os
 from dotenv import dotenv_values
 
-config = dotenv_values(".env")
+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"]

{papi_projects-0.1.2 → papi_projects-0.1.4}/papi/project.py

@@ -19,7 +19,7 @@ def check_project_id(id: str) -> bool:
     :rtype: bool
     """
     valid = False
-    pattern = re.compile(r"^P[0-9]{4}-[A-Z]{2}[A-Z0-9]{1}-[A-Z]{4}$")
+    pattern = re.compile(r"^P[0-9]{4}-[A-Z]{2}[A-Z1-9]{1}-[A-Z]{4}$")
     if pattern.match(id):
         valid = True
     return valid
@@ -104,6 +104,9 @@ class Project(Protocol):
             self.generate_suffix()
         if id is not None and check_project_id(id):
             self.id = id
+            self.year = int(id[1:5])
+            self.user_id = id.split("-")[1]
+            self.suffix = id.split("-")[2]
         elif (
             isinstance(year, int)
             and check_user_id(user_id)

{papi_projects-0.1.2 → papi_projects-0.1.4}/pyproject.toml

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