aplos-nca-saas-sdk 0.0.2__tar.gz → 0.0.4__tar.gz

{aplos_nca_saas_sdk-0.0.2 → aplos_nca_saas_sdk-0.0.4}/.vscode/settings.json

@@ -11,8 +11,7 @@
     ],
     "python.testing.cwd": "${workspaceFolder}",
     "python.analysis.extraPaths": [                
-        "${workspaceFolder}/src",
-        "${workspaceFolder}/src/aplos_nca_saas_sdk",        
+        "${workspaceFolder}/src",             
         "${workspaceFolder}/tests",
         "${workspaceFolder}/devops",
         "${workspaceFolder}/devops/cdk",

aplos_nca_saas_sdk-0.0.4/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.3
+Name: aplos_nca_saas_sdk
+Version: 0.0.4
+Summary: Aplos NCA SaaS SDK
+Project-URL: Homepage, https://aplosanalytics.com/
+Project-URL: Documentation, https://docs.aplosanalytics.com/
+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
+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
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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: 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
+Description-Content-Type: text/markdown
+
+# Aplos NCA SaaS SDK for python
+
+Welcome to the Aplos NCA SaaS SDK for automating your PK Analyis.  A secure set of API's to connect to our Cloud System and automate your PK analysis.
+
+This SDK works for our
+- Trial Accounts (Multi Tenancy)
+- Academic Accounts (Multi Tenancy)
+- Professional Accounts (Multi Tenancy)
+- Team Accounts (Single Tenancy)
+- Enterprise Accounts (Single Tenancy)
+
+## Use 🐍 python to perform an NCA Analysis with the Aplos NCA SaaS Solution.  
+If you can make HTTPS 🔐 request 🛜 - you can automation your PK Analysis Workflow Systems.
+
+## 👉 We use this for our demos 🚀🚀 👈
+> We'll keep this maintained as we use it for our customer demo as well as Integration Testings.  
+> So keep coming back for new features.
+>
+> If you're not sure how to get started, kick off the Integration Test Suite, set some break points
+> and you'll see a wide range of example use cases.
+
+## API Settings 🛑 A valid Aplos NCA Account is required. 🛑
+
+
+> In order to run the executions and connect to our system, you will need a valid account with an active subscription (reach out for a trial subscription if you are evaluating our solutions).
+>
+> You'll need your username (email address and a password), a Cognito Client Id
+> which allows the USER_PASSWORD_AUTH flow, and your API URL.
+>
+> Technically if you have your API Domain (from your account), you can use this to query for your Cognito Client Id  
+> 
+> Otherwise, the Client Id (aka Cognito Client Key) and API URL can be found in your user account.
+>
+> Your username is your email address and your password would have been provided to you during your
+> onboarding or with a "forgot password" request and reset.
+
+
+## API
+You can use the API to integrate the Aplos NCA SaaS Cloud Solution into your workflow.
+You can perform:
+- Logins
+- File Uploads
+- PK Analysis Executions
+- PK Analysis Results
+- File Downloads
+- PK Validations (run validations against our calculations engine)
+- Tenant & User Management (for Team & Enterprise Accounts)
+- and more...
+
+
+## API Integration Testing
+You can use the integration testing to test your environment. You can also use the Integration Testing modules
+to learn how to use the API.
+
+## Source
+Full source code can also be found on [GitHub](https://github.com/AplosAnalytics/Aplos-NCA-SaaS-SDK)
+
+## Documentation
+[The Docs](https://docs.aplosanalytics.com/)
+
+## Corporate Home Page
+[Aplos Analytics](https://aplosanalytics.com/)
+
+
+
+

aplos_nca_saas_sdk-0.0.4/README.md

@@ -0,0 +1,66 @@
+# Aplos NCA SaaS SDK for python
+
+Welcome to the Aplos NCA SaaS SDK for automating your PK Analyis.  A secure set of API's to connect to our Cloud System and automate your PK analysis.
+
+This SDK works for our
+- Trial Accounts (Multi Tenancy)
+- Academic Accounts (Multi Tenancy)
+- Professional Accounts (Multi Tenancy)
+- Team Accounts (Single Tenancy)
+- Enterprise Accounts (Single Tenancy)
+
+## Use 🐍 python to perform an NCA Analysis with the Aplos NCA SaaS Solution.  
+If you can make HTTPS 🔐 request 🛜 - you can automation your PK Analysis Workflow Systems.
+
+## 👉 We use this for our demos 🚀🚀 👈
+> We'll keep this maintained as we use it for our customer demo as well as Integration Testings.  
+> So keep coming back for new features.
+>
+> If you're not sure how to get started, kick off the Integration Test Suite, set some break points
+> and you'll see a wide range of example use cases.
+
+## API Settings 🛑 A valid Aplos NCA Account is required. 🛑
+
+
+> In order to run the executions and connect to our system, you will need a valid account with an active subscription (reach out for a trial subscription if you are evaluating our solutions).
+>
+> You'll need your username (email address and a password), a Cognito Client Id
+> which allows the USER_PASSWORD_AUTH flow, and your API URL.
+>
+> Technically if you have your API Domain (from your account), you can use this to query for your Cognito Client Id  
+> 
+> Otherwise, the Client Id (aka Cognito Client Key) and API URL can be found in your user account.
+>
+> Your username is your email address and your password would have been provided to you during your
+> onboarding or with a "forgot password" request and reset.
+
+
+## API
+You can use the API to integrate the Aplos NCA SaaS Cloud Solution into your workflow.
+You can perform:
+- Logins
+- File Uploads
+- PK Analysis Executions
+- PK Analysis Results
+- File Downloads
+- PK Validations (run validations against our calculations engine)
+- Tenant & User Management (for Team & Enterprise Accounts)
+- and more...
+
+
+## API Integration Testing
+You can use the integration testing to test your environment. You can also use the Integration Testing modules
+to learn how to use the API.
+
+## Source
+Full source code can also be found on [GitHub](https://github.com/AplosAnalytics/Aplos-NCA-SaaS-SDK)
+
+## Documentation
+[The Docs](https://docs.aplosanalytics.com/)
+
+## Corporate Home Page
+[Aplos Analytics](https://aplosanalytics.com/)
+
+
+
+

{aplos_nca_saas_sdk-0.0.2 → aplos_nca_saas_sdk-0.0.4}/devops/pypi/build.py

@@ -4,8 +4,8 @@ import shutil
 import subprocess
 from pathlib import Path
 from typing import List
-import toml
 
+import toml
 from aws_lambda_powertools import Logger
 
 logger = Logger()
@@ -35,8 +35,8 @@ def main():
 
 def run_local_clean_up():
     """run a local clean up and remove older items in the dist directory"""
-    root = Path(__file__).parent.parent
-    dist_dir = os.path.join(root, "dist")
+    project_root = Path(__file__).parents[2]
+    dist_dir = os.path.join(project_root, "dist")
     if os.path.exists(dist_dir):
         # clear it out
         shutil.rmtree(dist_dir)

{aplos_nca_saas_sdk-0.0.2 → aplos_nca_saas_sdk-0.0.4}/pyproject.toml

@@ -8,7 +8,25 @@ packages = ["src/aplos_nca_saas_sdk"]
 [project]
 name = "aplos_nca_saas_sdk"
 source = "src/aplos_nca_saas_sdk"
-version = "0.0.2"
+keywords = [
+    "PK Analysis",
+    "Pharmacokinetics",
+    "Non-Compartmental Analysis",
+    "NCA",
+    "PK modeling",
+    "SaaS",
+    "Clinical Pharmacology",
+    "Bioequivalence Studies",
+    "Bioavailability Studies",
+    "Dose-Proportionality Studies",
+    "Drug Interaction Studies",
+    "Pharmacokinetic Analysis",
+    "Pharmacokinetics Software",
+    "Pharma Data Analysis",
+    "Clinical Trials"
+]
+
+version = "0.0.4"
 authors = [
   { name="Eric Wilson", email="eric.wilson@aplosanalytics.com" }
 ]
@@ -28,11 +46,12 @@ classifiers = [
 ]
 
 dependencies = [
-  "aws-lambda-powertools==2.38.1",
+  "aws-lambda-powertools>=3.3.0",
   "requests==2.31.0",
   "boto3==1.34.110",  
   "python-dotenv==1.0.1",
-  "PyJWT==2.9.0"
+  "PyJWT==2.9.0",
+  "mypy_boto3_cognito_idp>=1.35.68"
 ]
 
 [project.urls]

aplos_nca_saas_sdk-0.0.4/readme.md

@@ -0,0 +1,66 @@
+# Aplos NCA SaaS SDK for python
+
+Welcome to the Aplos NCA SaaS SDK for automating your PK Analyis.  A secure set of API's to connect to our Cloud System and automate your PK analysis.
+
+This SDK works for our
+- Trial Accounts (Multi Tenancy)
+- Academic Accounts (Multi Tenancy)
+- Professional Accounts (Multi Tenancy)
+- Team Accounts (Single Tenancy)
+- Enterprise Accounts (Single Tenancy)
+
+## Use 🐍 python to perform an NCA Analysis with the Aplos NCA SaaS Solution.  
+If you can make HTTPS 🔐 request 🛜 - you can automation your PK Analysis Workflow Systems.
+
+## 👉 We use this for our demos 🚀🚀 👈
+> We'll keep this maintained as we use it for our customer demo as well as Integration Testings.  
+> So keep coming back for new features.
+>
+> If you're not sure how to get started, kick off the Integration Test Suite, set some break points
+> and you'll see a wide range of example use cases.
+
+## API Settings 🛑 A valid Aplos NCA Account is required. 🛑
+
+
+> In order to run the executions and connect to our system, you will need a valid account with an active subscription (reach out for a trial subscription if you are evaluating our solutions).
+>
+> You'll need your username (email address and a password), a Cognito Client Id
+> which allows the USER_PASSWORD_AUTH flow, and your API URL.
+>
+> Technically if you have your API Domain (from your account), you can use this to query for your Cognito Client Id  
+> 
+> Otherwise, the Client Id (aka Cognito Client Key) and API URL can be found in your user account.
+>
+> Your username is your email address and your password would have been provided to you during your
+> onboarding or with a "forgot password" request and reset.
+
+
+## API
+You can use the API to integrate the Aplos NCA SaaS Cloud Solution into your workflow.
+You can perform:
+- Logins
+- File Uploads
+- PK Analysis Executions
+- PK Analysis Results
+- File Downloads
+- PK Validations (run validations against our calculations engine)
+- Tenant & User Management (for Team & Enterprise Accounts)
+- and more...
+
+
+## API Integration Testing
+You can use the integration testing to test your environment. You can also use the Integration Testing modules
+to learn how to use the API.
+
+## Source
+Full source code can also be found on [GitHub](https://github.com/AplosAnalytics/Aplos-NCA-SaaS-SDK)
+
+## Documentation
+[The Docs](https://docs.aplosanalytics.com/)
+
+## Corporate Home Page
+[Aplos Analytics](https://aplosanalytics.com/)
+
+
+
+

{aplos_nca_saas_sdk-0.0.2 → aplos_nca_saas_sdk-0.0.4}/requirements.txt

@@ -3,3 +3,5 @@ boto3
 python-dotenv # load env values
 PyJWT # jwt in the imports
 requests
+boto3-stubs[cognito]
+mypy_boto3_cognito_idp

{aplos_nca_saas_sdk-0.0.2 → aplos_nca_saas_sdk-0.0.4}/src/aplos_nca_saas_sdk/aws_resources/aws_cognito.py

@@ -4,9 +4,11 @@ All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
 
+from typing import Optional
+
 import boto3
 import jwt as jwt_lib
-from typing import Optional
+from mypy_boto3_cognito_idp.client import CognitoIdentityProviderClient
 from aplos_nca_saas_sdk.nca_resources.nca_app_configuration import (
     NCAAppConfiguration,
 )
@@ -31,7 +33,7 @@ class CognitoAuthenication:
         self.__access_token: Optional[str] = None
         self.__refresh_token: Optional[str] = None
         self.__region: str = region or "us-east-1"
-        self.__client: Optional[boto3.client] = None
+        self.__client: Optional[CognitoIdentityProviderClient] = None
         self.__user_id: Optional[str] = None
         self.__tenant_id: Optional[str] = None
         self.__config: Optional[NCAAppConfiguration] = None
@@ -40,7 +42,7 @@ class CognitoAuthenication:
         self.__validate_parameters()
 
     @property
-    def client(self) -> boto3.client:
+    def client(self) -> CognitoIdentityProviderClient:
         """
         Get the boto3 client
 
@@ -53,7 +55,7 @@ class CognitoAuthenication:
         return self.__client
 
     @property
-    def client_id(self) -> str:
+    def client_id(self) -> str | None:
         """
         Client Id
         Returns:
@@ -62,7 +64,7 @@ class CognitoAuthenication:
         return self.__client_id
 
     @property
-    def region(self) -> str:
+    def region(self) -> str | None:
         """
         Region
         Returns:

aplos_nca_saas_sdk-0.0.4/src/aplos_nca_saas_sdk/integration_testing/configs/_config_base.py

@@ -0,0 +1,13 @@
+from typing import Dict
+from typing import Any
+
+
+class ConfigBase:
+    """Base Configuration Class"""
+
+    def __init__(self, enabled: bool = True):
+        self.enabled: bool = enabled
+
+    def load(self, test_config: Dict[str, Any]):
+        """Load the configuration from a dictionary"""
+        self.enabled = test_config.get("enabled", True)

aplos_nca_saas_sdk-0.0.4/src/aplos_nca_saas_sdk/integration_testing/configs/app_settings.py

@@ -0,0 +1,60 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from typing import List, Dict, Any
+from aplos_nca_saas_sdk.integration_testing.configs._config_base import ConfigBase
+
+
+class ApplicationDomain(ConfigBase):
+    """
+    Application Domain: Defines the domains that the application configuration tests will check against
+
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.__domain: str | None = None
+
+    @property
+    def domain(self) -> str:
+        """The domain to validate"""
+        if self.__domain is None:
+            raise RuntimeError("Domain is not set")
+        return self.__domain
+
+    @domain.setter
+    def domains(self, value: str):
+        self.__domain = value
+
+
+class ApplicationSettings:
+    """
+    Application Settings: Defines the domains that the application settings (configuration endpoint) tests will check against
+
+    """
+
+    def __init__(self):
+        self.__domains: List[ApplicationDomain] = []
+
+    @property
+    def domains(self) -> List[ApplicationDomain]:
+        return self.__domains
+
+    @domains.setter
+    def domains(self, value: List[ApplicationDomain]):
+        self.__domains = value
+
+    def load(self, test_config: Dict[str, Any]):
+        """Load the domains from the config"""
+        domains: List[Dict[str, Any]] = test_config.get("domains", [])
+
+        domain: Dict[str, Any]
+        for domain in domains:
+            app_domain = ApplicationDomain()
+            app_domain.domains = domain.get("domain", None)
+            app_domain.enabled = bool(domain.get("enabled", True))
+
+            self.__domains.append(app_domain)

aplos_nca_saas_sdk-0.0.4/src/aplos_nca_saas_sdk/integration_testing/configs/config_sample.json

@@ -0,0 +1,105 @@
+{
+    "application_config_test": {
+        "purpose": "Tests the application configuration endpoints",
+        "domains": [
+            {
+                "domain": "api.example.com",
+                "expected_results" : {
+                    "status_code": 200
+                },
+                "enabled": true
+            },
+            {
+                "domain": "XXXXXXXXXXXXXXXXXXXXX",
+                "expected_results" : {
+                    "status_code": 403
+                },
+                "enabled": false
+            }
+        ]
+    },
+    "login_test": {
+        "purpose": "Tests the login endpoints",
+        "logins": [
+            {
+                "username": "foo",
+                "password": "barr",
+                "domain": "api.example.com",
+                "roles": []
+                
+            },
+            {
+                "username": "XXXXXXXXXXXXXXXXXXXXX",
+                "password": "XXXXXXXXXXXXXXXXXXXXX",
+                "domain": "XXXXXXXXXXXXXXXXXXXXX",
+                "roles": [
+                    "XXXXXXXXXXXXXXXXXXXXX"
+                ],
+                "enabled" : false,
+                "expected_results" : {
+                    "exception": "InvalidCredentialsException"
+                }
+            }
+        ]    
+    },
+    "file_upload_test": {
+        "purpose": "Tests the file upload endpoints.",
+        "notes": "a file can be on the local drive or pulled from a public https source.",
+        "login": {
+            "purpose": "optional: if present this login is used, unless a specific login is defined for the test",
+            "username": "foo",
+            "password": "bar",
+            "domain": "api.example.com"          
+        },
+        "files": [
+            {
+                "file": "XXXXXXXXXXXXXXXXXXXXX",                
+                "expected_results" : {
+                    "status_code": 200
+                }
+            },
+            {
+                "file": "XXXXXXXXXXXXXXXXXXXXX",
+                "login" : {
+                    "purpose": "optional: if present tests an upload for a specific user",
+                    "username": "XXXXXXXXXXXXXXXXXXXXX",
+                    "password": "XXXXXXXXXXXXXXXXXXXXX",
+                    "domain": "XXXXXXXXXXXXXXXXXXXXX" 
+                },
+                "expected_results" : {
+                    "status_code": 403
+                }
+            }
+        ]
+    },
+    "analysis_execution_test": {
+        "purpose": "Tests the analysis execution endpoints.",
+        "login": {
+            "username": "XXXXXXXXXXXXXXXXXXXXX",
+            "password": "XXXXXXXXXXXXXXXXXXXXX",
+            "domain": "XXXXXXXXXXXXXXXXXXXXX"          
+        },
+        "analyses": [
+            {                
+                "file": "XXXXXXXXXXXXXXXXXXXXX",
+                "meta": {},
+                "config": {},
+                "expected_results" : {
+                    "status_code": 200
+                }
+            }
+        ]
+    },
+    "validation_test": {
+        "purpose": "Tests the validation execution.",
+        "login": {
+            "username": "XXXXXXXXXXXXXXXXXXXXX",
+            "password": "XXXXXXXXXXXXXXXXXXXXX",
+            "domain": "XXXXXXXXXXXXXXXXXXXXX"          
+        },
+        "expected_results": {
+            "status_code": 200
+        }
+    }
+    
+}

aplos_nca_saas_sdk-0.0.4/src/aplos_nca_saas_sdk/integration_testing/configs/login.py

@@ -0,0 +1,105 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from typing import List, Optional, Dict, Any
+from aplos_nca_saas_sdk.integration_testing.configs._config_base import ConfigBase
+
+
+class Login(ConfigBase):
+    """
+    Application Login: Defines the login that the application configuration tests will check against
+
+    """
+
+    def __init__(
+        self,
+        username: Optional[str] = None,
+        passord: Optional[str] = None,
+        domain: Optional[str] = None,
+        roles: Optional[List[str]] = None,
+    ):
+        super().__init__()
+        self.__username: Optional[str] = username
+        self.__password: Optional[str] = passord
+        self.__domain: Optional[str] = domain
+        self.__roles: List[str] = roles if roles is not None else []
+
+    @property
+    def username(self) -> str:
+        if self.__username is None:
+            raise RuntimeError("Username is not set")
+        return self.__username
+
+    @username.setter
+    def username(self, value: str):
+        self.__username = value
+
+    @property
+    def password(self) -> str:
+        if self.__password is None:
+            raise RuntimeError("Password is not set")
+        return self.__password
+
+    @password.setter
+    def password(self, value: str):
+        self.__password = value
+
+    @property
+    def domain(self) -> str:
+        if self.__domain is None:
+            raise RuntimeError("Domain is not set")
+        return self.__domain
+
+    @domain.setter
+    def domain(self, value: str):
+        self.__domain = value
+
+    @property
+    def roles(self) -> List[str]:
+        """A list of roles to check for"""
+        return self.__roles
+
+    @roles.setter
+    def roles(self, value: List[str] | None):
+        if value is None:
+            value = []
+        self.__roles = value
+
+
+class Logins(ConfigBase):
+    """
+    Application Logins: Defines the logins that the application configuration tests will check against
+
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.__logins: List[Login] = []
+
+    @property
+    def list(self) -> List[Login]:
+        """List the logins"""
+        return self.__logins
+
+    def add(self, *, username: str, password: str, domain: str, enabled: bool = True):
+        """Add a loging"""
+        login = Login()
+        login.username = username
+        login.password = password
+        login.domain = domain
+        login.enabled = enabled
+        self.__logins.append(login)
+
+    def load(self, test_config: Dict[str, Any]):
+        """Load the logins from a list of dictionaries"""
+        self.enabled = bool(test_config.get("enabled", True))
+        logins: List[Dict[str, str]] = test_config.get("logins", [])
+        for login in logins:
+            self.add(
+                username=login["username"],
+                password=login["password"],
+                domain=login["domain"],
+            )