aplos-nca-saas-sdk 0.0.7__tar.gz → 0.0.9__tar.gz

{aplos_nca_saas_sdk-0.0.7 → aplos_nca_saas_sdk-0.0.9}/.gitignore

@@ -11,3 +11,4 @@ dist/
 # don't track environment files
 .env
 .env.*
+.config.*

{aplos_nca_saas_sdk-0.0.7 → aplos_nca_saas_sdk-0.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: aplos_nca_saas_sdk
-Version: 0.0.7
+Version: 0.0.9
 Summary: Aplos NCA SaaS SDK
 Project-URL: Homepage, https://aplosanalytics.com/
 Project-URL: Documentation, https://docs.aplosanalytics.com/
@@ -8,6 +8,7 @@ Project-URL: Repository, https://github.com/AplosAnalytics/Aplos-NCA-SaaS-SDK
 Project-URL: Issues, https://github.com/AplosAnalytics/Aplos-NCA-SaaS-SDK/issues
 Author-email: Eric Wilson <eric.wilson@aplosanalytics.com>
 License: MIT License
+License-File: LICENSE
 Keywords: Bioavailability Studies,Bioequivalence Studies,Clinical Pharmacology,Clinical Trials,Dose-Proportionality Studies,Drug Interaction Studies,NCA,Non-Compartmental Analysis,PK Analysis,PK modeling,Pharma Data Analysis,Pharmacokinetic Analysis,Pharmacokinetics,Pharmacokinetics Software,SaaS
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
@@ -17,11 +18,11 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.10
 Requires-Dist: aws-lambda-powertools>=3.3.0
-Requires-Dist: boto3==1.34.110
+Requires-Dist: boto3>=1.34.110
 Requires-Dist: mypy-boto3-cognito-idp>=1.35.68
-Requires-Dist: pyjwt==2.9.0
-Requires-Dist: python-dotenv==1.0.1
-Requires-Dist: requests==2.31.0
+Requires-Dist: pyjwt>=2.9.0
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: requests>=2.31.0
 Description-Content-Type: text/markdown
 
 # Aplos NCA SaaS SDK for python

{aplos_nca_saas_sdk-0.0.7 → aplos_nca_saas_sdk-0.0.9}/pyproject.toml

@@ -26,7 +26,7 @@ keywords = [
     "Clinical Trials"
 ]
 
-version = "0.0.7"
+version = "0.0.9"
 authors = [
   { name="Eric Wilson", email="eric.wilson@aplosanalytics.com" }
 ]
@@ -47,10 +47,10 @@ classifiers = [
 
 dependencies = [
   "aws-lambda-powertools>=3.3.0",
-  "requests==2.31.0",
-  "boto3==1.34.110",  
-  "python-dotenv==1.0.1",
-  "PyJWT==2.9.0",
+  "requests>=2.31.0",
+  "boto3>=1.34.110",  
+  "python-dotenv>=1.0.1",
+  "PyJWT>=2.9.0",
   "mypy_boto3_cognito_idp>=1.35.68"
 ]
 

{aplos_nca_saas_sdk-0.0.7 → aplos_nca_saas_sdk-0.0.9}/src/aplos_nca_saas_sdk/aws_resources/aws_s3_presigned_upload.py

@@ -6,6 +6,7 @@ Property of Aplos Analytics, Utah, USA
 
 import json
 import os
+from typing import Any, Dict
 
 import requests
 from aplos_nca_saas_sdk.aws_resources.aws_s3_presigned_payload import (
@@ -21,7 +22,7 @@ class S3PresignedUpload:
         self.api_url = api_url
         self.jwt = jwt
 
-    def upload_file(self, input_file: str) -> S3PresignedPayload:
+    def upload_file(self, input_file: str) -> Dict[str, Any]:
         """
         Uploads a file to your Aplos Cloud Account in AWS
 
@@ -29,7 +30,7 @@ class S3PresignedUpload:
             input_file (str): path to the analysis file you are uploading
 
         Returns:
-            S3PresignedPayload: an instance of S3PresignedPayload
+            Dictionary: including the file_id, status code and response information
         """
 
         # get the presigned url for uploading
@@ -37,14 +38,14 @@ class S3PresignedUpload:
             input_file=input_file
         )
         # upload the files
-        self.__upload_file_to_s3(paylod, input_file=input_file)
+        upload_response = self.__upload_file_to_s3(paylod, input_file=input_file)
 
-        return paylod
+        return upload_response
 
     def __get_presigned_upload_info(self, input_file: str) -> S3PresignedPayload:
         """
         Performs all the necessary steps for creating a presigned url to upload a file to S3.
-        We're using AWS S3 presigned urls for security as well as allowing for very large files if requried.
+        We're using AWS S3 presigned urls for security as well as allowing for very large files if required.
         Args:
             input_file (str): the path to the input (analysis) file
 
@@ -79,7 +80,9 @@ class S3PresignedUpload:
 
         return payload
 
-    def __upload_file_to_s3(self, payload: S3PresignedPayload, input_file: str) -> bool:
+    def __upload_file_to_s3(
+        self, payload: S3PresignedPayload, input_file: str
+    ) -> Dict[str, Any]:
         """
         Peforms the actual uploading via a presigned url for S3 bucket storage
         Args:
@@ -107,7 +110,11 @@ class S3PresignedUpload:
 
         # Check the response: 204 is a success in this case
         if upload_response and upload_response.status_code == 204:
-            return True
+            return {
+                "status_code": upload_response.status_code,
+                "reason": upload_response.reason,
+                "file_id": payload.file_id,
+            }
         else:
             raise RuntimeError(
                 "Error uploading the file. "

{aplos_nca_saas_sdk-0.0.7 → aplos_nca_saas_sdk-0.0.9}/src/aplos_nca_saas_sdk/integration_testing/configs/config_sample.json

@@ -53,10 +53,7 @@
         },
         "files": [
             {
-                "file": "XXXXXXXXXXXXXXXXXXXXX",                
-                "expected_results" : {
-                    "status_code": 200
-                }
+                "file": "XXXXXXXXXXXXXXXXXXXXX"
             },
             {
                 "file": "XXXXXXXXXXXXXXXXXXXXX",
@@ -65,9 +62,6 @@
                     "username": "XXXXXXXXXXXXXXXXXXXXX",
                     "password": "XXXXXXXXXXXXXXXXXXXXX",
                     "domain": "XXXXXXXXXXXXXXXXXXXXX" 
-                },
-                "expected_results" : {
-                    "status_code": 403
                 }
             }
         ]

aplos_nca_saas_sdk-0.0.9/src/aplos_nca_saas_sdk/integration_testing/configs/file_upload.py

@@ -0,0 +1,104 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+import os
+from typing import List, Dict, Any
+from aplos_nca_saas_sdk.integration_testing.configs._config_base import ConfigBase
+from aplos_nca_saas_sdk.integration_testing.configs.login import Login
+from aplos_nca_saas_sdk.utilities.environment_services import EnvironmentServices
+
+
+class FileUpload(ConfigBase):
+    """
+    File Upload: Defines the login that the application configuration tests will check against
+
+    """
+
+    def __init__(self, login: Login, filepath: str):
+        super().__init__()
+        if login is None:
+            raise RuntimeError("Login is required")
+        self.__login = login
+        if filepath is None:
+            raise RuntimeError("Filepath is required")
+        self.__filepath = filepath
+
+    @property
+    def login(self) -> Login:
+        """The users login"""
+        return self.__login
+
+    @property
+    def filepath(self) -> str:
+        """The file path to file being uploaded"""
+        path = self.__load_filepath(self.__filepath)
+
+        if not os.path.exists(path):
+            raise RuntimeError(f"The Upload File was not found: {path}")
+
+        return path
+
+    def __load_filepath(self, filepath: str) -> str:
+        """Load the filepath"""
+        if filepath is None:
+            raise RuntimeError("Filepath is required")
+        elif filepath.startswith("${module}"):
+            # find the path
+            es: EnvironmentServices = EnvironmentServices()
+            root = es.find_module_path()
+            filepath = filepath.replace("${module}", root)
+
+        # get the correct os path separator
+        filepath = os.path.normpath(filepath)
+        return filepath
+
+
+class FileUploads(ConfigBase):
+    """
+    File Uploads: Defines the files that the application file upload tests will check against
+
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.__fileuploads: List[FileUpload] = []
+
+    @property
+    def list(self) -> List[FileUpload]:
+        """List the file uploads"""
+        return filter(lambda x: x.enabled, self.__fileuploads)
+
+    def add(self, *, filepath: str, login: Login, enabled: bool = True):
+        """Add a file upload"""
+        fileupload = FileUpload(login, filepath)
+        fileupload.enabled = enabled
+        self.__fileuploads.append(fileupload)
+
+    def load(self, test_config: Dict[str, Any]):
+        """Load the file uploads from a list of dictionaries"""
+
+        super().load(test_config)
+        test_config_login: Login = self.try_load_login(test_config.get("login", None))
+        fileuploads: List[Dict[str, Any]] = test_config.get("files", [])
+        login: Login = None
+        for fileupload in fileuploads:
+            enabled = bool(fileupload.get("enabled", True))
+            if "login" in fileupload:
+                login = self.try_load_login(fileupload["login"])
+            else:
+                login = test_config_login
+
+            self.add(filepath=fileupload["file"], login=login, enabled=enabled)
+
+    def try_load_login(self, login_config: Dict[str, Any]) -> Login | None:
+        """Attempts to intialize a Login from a configuration object"""
+        login: Login = None
+        if login_config is not None:
+            username = login_config.get("username", None)
+            password = login_config.get("password", None)
+            domain = login_config.get("domain", None)
+            login = Login(username, password, domain)
+        return login

aplos_nca_saas_sdk-0.0.9/src/aplos_nca_saas_sdk/integration_testing/files/uploads/input1.csv

@@ -0,0 +1,13 @@
+subject,dose,time,conc,conc_obs
+1,10000,0,0,BLQ
+1,10000,0.5,0,BLQ
+1,10000,1,0,BLQ
+1,10000,1.5,0,BLQ
+1,10000,2,0,BLQ
+1,10000,4,449,449
+1,10000,6,210,210
+1,10000,8,286,286
+1,10000,12,130,130
+1,10000,16,43.4,43.4
+1,10000,20,16.8,16.8
+1,10000,24,10.6,10.6

aplos_nca_saas_sdk-0.0.9/src/aplos_nca_saas_sdk/integration_testing/files/uploads/input1.data

@@ -0,0 +1,13 @@
+subject,dose,time,conc,conc_obs
+1,10000,0,0,BLQ
+1,10000,0.5,0,BLQ
+1,10000,1,0,BLQ
+1,10000,1.5,0,BLQ
+1,10000,2,0,BLQ
+1,10000,4,449,449
+1,10000,6,210,210
+1,10000,8,286,286
+1,10000,12,130,130
+1,10000,16,43.4,43.4
+1,10000,20,16.8,16.8
+1,10000,24,10.6,10.6

{aplos_nca_saas_sdk-0.0.7 → aplos_nca_saas_sdk-0.0.9}/src/aplos_nca_saas_sdk/integration_testing/integration_test_base.py

@@ -5,6 +5,7 @@ Property of Aplos Analytics, Utah, USA
 """
 
 from typing import Dict, Any, List
+from abc import ABC, abstractmethod
 
 from aplos_nca_saas_sdk.integration_testing.integration_test_configurations import (
     TestConfiguration,
@@ -14,7 +15,7 @@ from aplos_nca_saas_sdk.integration_testing.integration_test_response import (
 )
 
 
-class IntegrationTestBase:
+class IntegrationTestBase(ABC):
     """
     Integration Test Base Class
     """
@@ -75,6 +76,7 @@ class IntegrationTestBase:
         """
         return [result.error for result in self.results if result.error is not None]
 
+    @abstractmethod
     def test(self) -> bool:
         """
         Run the Test
@@ -85,4 +87,4 @@ class IntegrationTestBase:
             of the tests fail, it will be false.  Execeptions are only
             raised if the raise_on_failure flag is set to True.
         """
-        raise RuntimeError("This should be implemented by the subclass.")
+        pass

{aplos_nca_saas_sdk-0.0.7 → aplos_nca_saas_sdk-0.0.9}/src/aplos_nca_saas_sdk/integration_testing/integration_test_configurations.py

@@ -9,6 +9,7 @@ from typing import Any, Dict
 from aplos_nca_saas_sdk.integration_testing.configs.app_settings import (
     ApplicationSettings,
 )
+from aplos_nca_saas_sdk.integration_testing.configs.file_upload import FileUploads
 from aplos_nca_saas_sdk.integration_testing.configs.login import Logins
 
 
@@ -21,7 +22,7 @@ class TestConfiguration:
     def __init__(self):
         self.app_config: ApplicationSettings = ApplicationSettings()
         self.logins: Logins = Logins()
-
+        self.file_uploads: FileUploads = FileUploads()
     def load(self, file_path: str):
         """
         Loads the configuration from a file
@@ -36,3 +37,4 @@ class TestConfiguration:
 
         self.logins.load(config.get("login_test", {}))
         self.app_config.load(config.get("application_config_test", {}))
+        self.file_uploads.load(config.get("file_upload_test", {}))

{aplos_nca_saas_sdk-0.0.7 → aplos_nca_saas_sdk-0.0.9}/src/aplos_nca_saas_sdk/integration_testing/integration_test_factory.py

@@ -4,6 +4,7 @@ All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
 
+from abc import ABC
 import os
 from typing import List
 from pathlib import Path
@@ -12,6 +13,7 @@ import inspect
 from aplos_nca_saas_sdk.integration_testing.integration_test_base import (
     IntegrationTestBase,
 )
+from aplos_nca_saas_sdk.integration_testing.tests.file_upload_test import FileUploadTest
 
 
 class IntegrationTestFactory:

{aplos_nca_saas_sdk-0.0.7 → aplos_nca_saas_sdk-0.0.9}/src/aplos_nca_saas_sdk/integration_testing/integration_test_suite.py

@@ -102,7 +102,7 @@ class IntegrationTestSuite:
                 f"  {test_result['test_name']} {'succeeded' if test_result['success'] else 'failed'} duration: {duration}"
             )
             if not test_result["success"]:
-                print(f"    Error: {test_result['errors']}")
+                print(f"    Errors: {test_result['errors']}")
 
         print(f"Test Suite completed in {datetime.now(UTC) - start_time}")
 

aplos_nca_saas_sdk-0.0.9/src/aplos_nca_saas_sdk/integration_testing/tests/file_upload_test.py

@@ -0,0 +1,150 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+import time
+from datetime import datetime, timedelta
+from typing import Any, Dict
+
+import requests
+
+from aplos_nca_saas_sdk.integration_testing.configs.login import Login
+from aplos_nca_saas_sdk.integration_testing.integration_test_base import (
+    IntegrationTestBase,
+)
+from aplos_nca_saas_sdk.integration_testing.integration_test_response import (
+    IntegrationTestResponse,
+)
+from aplos_nca_saas_sdk.nca_resources.nca_file_upload import NCAFileUpload
+from aplos_nca_saas_sdk.nca_resources.nca_login import NCALogin
+from aplos_nca_saas_sdk.utilities.http_utility import HttpUtilities
+
+
+class FileUploadTest(IntegrationTestBase):
+    """File Upload Test Container"""
+
+    def __init__(self):
+        super().__init__("file-upload")
+
+    def test(self) -> bool:
+        """Test file upload"""
+
+        self.results.clear()
+
+        for fileupload in self.config.file_uploads.list:
+            test_response: IntegrationTestResponse = IntegrationTestResponse()
+            test_response.name = self.name
+            try:
+                # Confirm Login
+                nca_login = self.__login(fileupload.login)
+                if not nca_login.jwt:
+                    test_response.error = "Failed to authenticate"
+                else:
+                    # Confirm Upload
+                    upload_response: Dict[str, Any] = self.__upload(
+                        nca_login, fileupload.filepath
+                    )
+                    if upload_response is None:
+                        test_response.error = "Failed to upload"
+                    else:
+                        # Confirm conversion and download
+                        # Allow time buffer so file data is available
+                        time.sleep(3)
+                        self.__download(
+                            nca_login, upload_response.get("file_id"), test_response
+                        )
+
+            except Exception as e:  # pylint: disable=w0718
+                test_response.error = str(e)
+
+            self.results.append(test_response)
+
+        return self.success()
+
+    def __login(self, login: Login) -> NCALogin:
+        nca_login = NCALogin(aplos_saas_domain=login.domain)
+        nca_login.authenticate(username=login.username, password=login.password)
+        return nca_login
+
+    def __upload(self, nca_login: NCALogin, upload_file_path: str) -> Dict[str, Any]:
+        nca_file_upload = NCAFileUpload(nca_login)
+        upload_response: Dict[str, Any] = nca_file_upload.upload(upload_file_path)
+        return upload_response
+
+    def __download(
+        self,
+        nca_login: NCALogin,
+        file_id: str,
+        test_response: IntegrationTestResponse,
+    ):
+        file_data_endpoint = nca_login.config.endpoints.file_data(
+            nca_login.cognito.tenant_id,
+            nca_login.cognito.user_id,
+            file_id,
+        )
+        file_info_endpoint = nca_login.config.endpoints.file(
+            nca_login.cognito.tenant_id,
+            nca_login.cognito.user_id,
+            file_id,
+        )
+
+        max_wait_in_minutes: int = 3
+        headers = HttpUtilities.get_headers(nca_login.jwt)
+        current_time = datetime.now()
+
+        # Create a timedelta object representing 3 minutes
+        time_delta = timedelta(minutes=max_wait_in_minutes)
+        # Add the timedelta to the current time
+        max_time = current_time + time_delta
+
+        complete = False
+        while not complete:
+            response = requests.get(file_info_endpoint, headers=headers, timeout=60)
+            json_response: dict = response.json()
+            errors = []
+            errors.extend(json_response.get("errors") or [])
+            status = json_response.get("workable_state")
+            complete = status == "ready"
+
+            if status == "invalid" or len(errors) > 0:
+                test_response.success = False
+                test_response.error = (
+                    "File conversion failed."
+                    if len(errors) < 0
+                    else f"File conversion failed with errors ${errors}."
+                )
+                break
+            if complete:
+                break
+            if not complete:
+                time.sleep(5)
+            if datetime.now() > max_time:
+                test_response.success = False
+                test_response.error = (
+                    "Timeout attempting to get conversion file status. "
+                    f"The current timeout limit is {max_wait_in_minutes} minutes. "
+                    "You may need to up the timeout period, or check for errors. "
+                )
+                break
+
+        if test_response.error is not None:
+            return
+
+        file_response = requests.get(file_data_endpoint, headers=headers, timeout=30)
+
+        json_file_response: dict = file_response.json()
+        data = json_file_response.get("data", None)
+        error = json_file_response.get("error", None)
+
+        if data is None:
+            test_response.success = False
+            test_response.error = "File download missing expected data. "
+        if error is not None:
+            test_response.success = False
+            test_response.error = (
+                test_response.error or ""
+            ) + f"File download contained error ${error}"
+
+        test_response.success = True

{aplos_nca_saas_sdk-0.0.7 → aplos_nca_saas_sdk-0.0.9}/src/aplos_nca_saas_sdk/nca_resources/nca_endpoints.py

@@ -52,3 +52,7 @@ class NCAEndpoints:
     def file(self, tenant_id: str, user_id: str, file_id: str) -> str:
         """Returns the file endpoint"""
         return f"{self.files(tenant_id=tenant_id, user_id=user_id)}/{file_id}"
+    
+    def file_data(self, tenant_id: str, user_id: str, file_id: str) -> str:
+        """Returns get file data endpoint"""
+        return f"{self.__base(tenant_id=tenant_id, user_id=user_id)}/nca/files/{file_id}/data"

{aplos_nca_saas_sdk-0.0.7 → aplos_nca_saas_sdk-0.0.9}/src/aplos_nca_saas_sdk/nca_resources/nca_executions.py

@@ -10,12 +10,11 @@ import time
 import zipfile
 from datetime import datetime, timedelta
 from pathlib import Path
+from typing import Any, Dict
 
 import requests
+
 from aplos_nca_saas_sdk.aws_resources.aws_cognito import CognitoAuthenication
-from aplos_nca_saas_sdk.aws_resources.aws_s3_presigned_payload import (
-    S3PresignedPayload,
-)
 from aplos_nca_saas_sdk.aws_resources.aws_s3_presigned_upload import (
     S3PresignedUpload,
 )
@@ -90,12 +89,12 @@ class NCAEngine:
         if self.verbose:
             print("\tUploading the analysis file.")
         uploader: S3PresignedUpload = S3PresignedUpload(self.jwt, str(self.api_root))
-        presign_payload: S3PresignedPayload = uploader.upload_file(input_file_path)
+        upload_response: Dict[str, Any] = uploader.upload_file(input_file_path)
 
         if self.verbose:
             print("\tStarting the execution.")
         execution_id = self.run_analysis(
-            file_id=str(presign_payload.file_id),
+            file_id=upload_response.get("file_id", ""),
             config_data=config_data,
             meta_data=meta_data,
         )
@@ -131,6 +130,13 @@ class NCAEngine:
             str: the execution id
         """
 
+        if not file_id:
+            raise ValueError("Missing file_id.  Please provide a valid file_id.")
+
+        if not config_data:
+            raise ValueError(
+                "Missing config_data.  Please provide a valid config_data."
+            )
         headers = HttpUtilities.get_headers(self.jwt)
         # to start a new execution we need the location of the file (s3 bucket and object key)
         # you basic configuration

aplos_nca_saas_sdk-0.0.9/src/aplos_nca_saas_sdk/nca_resources/nca_file_upload.py

@@ -0,0 +1,57 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from typing import Any, Dict
+from aplos_nca_saas_sdk.aws_resources.aws_s3_presigned_upload import S3PresignedUpload
+from aplos_nca_saas_sdk.nca_resources.nca_login import NCALogin
+from aplos_nca_saas_sdk.utilities.http_utility import HttpUtilities
+
+
+class NCAFileUpload:
+    """NCA File Upload"""
+
+    def __init__(self, nca_login: NCALogin) -> None:
+        if nca_login is None or nca_login.jwt is None or not nca_login.jwt:
+            raise ValueError("Authenticated nca_login is required.")
+
+        self.__api_domain: str = nca_login.domain
+        self.__tenant_id: str = nca_login.cognito.tenant_id
+        self.__user_id: str = nca_login.cognito.user_id
+        self.__jwt: str = nca_login.jwt
+
+    @property
+    def api_root(self) -> str:
+        """Gets the base url"""
+
+        if self.__api_domain is None:
+            raise RuntimeError("Missing Aplos Api Domain")
+
+        url = HttpUtilities.build_url(self.__api_domain)
+        if isinstance(url, str):
+            return f"{url}/tenants/{self.__tenant_id}/users/{self.__user_id}"
+
+        raise RuntimeError("Missing Aplos Api Domain")
+
+    def upload(self, input_file_path: str) -> Dict[str, Any]:
+        """
+        Uploads a file to the Aplos NCA Cloud
+
+        Args:
+            input_file_path (str): local path to the file
+
+        Raises:
+            ValueError: _description_
+
+        Returns:
+            Dict: {"file_id": id, "statu_code": 204}
+        """
+        if input_file_path is None or not input_file_path:
+            raise ValueError("Valid input_file_path is required.")
+
+        uploader: S3PresignedUpload = S3PresignedUpload(self.__jwt, str(self.api_root))
+        upload_response: Dict[str, Any] = uploader.upload_file(input_file_path)
+
+        return upload_response

{aplos_nca_saas_sdk-0.0.7 → aplos_nca_saas_sdk-0.0.9}/src/aplos_nca_saas_sdk/utilities/environment_services.py

@@ -59,7 +59,7 @@ class EnvironmentServices:
     def find_file(
         self, starting_path: str, file_name: str, raise_error_if_not_found: bool = True
     ) -> str | None:
-        """Searches the project directory structor for a file"""
+        """Searches the project directory structure for a file"""
         parents = 10
         starting_path = starting_path or __file__
 
@@ -79,3 +79,30 @@ class EnvironmentServices:
             )
 
         return None
+
+    def find_module_path(
+        self,
+        starting_path: str | None = None,
+        raise_error_if_not_found: bool = True,
+    ) -> str | None:
+        """From a given starting point, move up the directory chain until you find the modules root"""
+        parents = 10
+        starting_path = starting_path or __file__
+        MODULE_ROOT = "aplos_nca_saas_sdk"  # pylint: disable=c0103
+        paths: List[str] = []
+        for parent in range(parents):
+            path = Path(starting_path).parents[parent].absolute()
+
+            # get the directory name
+            directory_name = os.path.basename(path)
+            if directory_name == MODULE_ROOT:
+                # return the full path
+                return str(path)
+
+        if raise_error_if_not_found:
+            searched_paths = "\n".join(paths)
+            raise RuntimeError(
+                f"Failed to locate the moduel root: {MODULE_ROOT} in: \n {searched_paths}"
+            )
+
+        return None

{aplos_nca_saas_sdk-0.0.7 → aplos_nca_saas_sdk-0.0.9}/src/aplos_nca_saas_sdk/version.py

@@ -1,4 +1,4 @@
 # Aplos NCA SaaS SDK Version File
 # This is automatically generated during the build process. 
 # DO NOT UPDATE IT DIRECTLY. IT WILL BE OVERWRITTEN. 
-__version__ = '0.0.7'
+__version__ = '0.0.9'