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

aplos_nca_saas_sdk-0.0.3/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.3
+Name: aplos_nca_saas_sdk
+Version: 0.0.3
+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==2.38.1
+Requires-Dist: boto3==1.34.110
+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.3/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.3}/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.3"
 authors = [
   { name="Eric Wilson", email="eric.wilson@aplosanalytics.com" }
 ]

aplos_nca_saas_sdk-0.0.3/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.3}/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.3}/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.3/src/aplos_nca_saas_sdk/integration_testing/configs/app_config.py

@@ -0,0 +1,25 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from typing import List
+
+
+class TestApplicationConfiguration:
+    """
+    Application Configuration: Defines the domains that the application configuration tests will check against
+
+    """
+
+    def __init__(self):
+        self.__domains: List[str] = []
+
+    @property
+    def domains(self) -> List[str]:
+        return self.__domains
+
+    @domains.setter
+    def domains(self, value: List[str]):
+        self.__domains = value

aplos_nca_saas_sdk-0.0.3/src/aplos_nca_saas_sdk/integration_testing/configs/config.py

@@ -0,0 +1,21 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from aplos_nca_saas_sdk.integration_testing.configs.app_config import (
+    TestApplicationConfiguration,
+)
+from aplos_nca_saas_sdk.integration_testing.configs.login import TestLogins
+
+
+class TestConfiguration:
+    """
+    Testing Suite Configuration: Provides a way to define the testing configuration for the Aplos Analytics SaaS SDK
+
+    """
+
+    def __init__(self):
+        self.app_config: TestApplicationConfiguration = TestApplicationConfiguration()
+        self.logins: TestLogins = TestLogins()

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

@@ -0,0 +1,77 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from typing import List, Optional
+
+
+class TestLogin:
+    """
+    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,
+    ):
+        self.__username: Optional[str] = username
+        self.__password: Optional[str] = passord
+        self.__domain: Optional[str] = domain
+
+    @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
+
+
+class TestLogins:
+    """
+    Application Logins: Defines the logins that the application configuration tests will check against
+
+    """
+
+    def __init__(self):
+        self.__logins: List[TestLogin] = []
+
+    @property
+    def list(self) -> List[TestLogin]:
+        """List the logins"""
+        return self.__logins
+
+    def add(self, *, username: str, password: str, domain: str):
+        """Add a loging"""
+        login = TestLogin()
+        login.username = username
+        login.password = password
+        login.domain = domain
+        self.__logins.append(login)

aplos_nca_saas_sdk-0.0.3/src/aplos_nca_saas_sdk/integration_testing/integration_test_base.py

@@ -0,0 +1,68 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from typing import Dict, Any, List
+
+from aplos_nca_saas_sdk.integration_testing.configs.config import TestConfiguration
+from aplos_nca_saas_sdk.integration_testing.integration_test_response import (
+    IntegrationTestResponse,
+)
+
+
+class IntegrationTestBase:
+    """
+    Integration Test Base Class
+    """
+
+    def __init__(self, name: str | None = None, index: int = 0):
+        self.name = name
+        self.index = index
+        self.__config: TestConfiguration | None = None
+        self.__results: List[IntegrationTestResponse] = []
+
+    @property
+    def config(self) -> TestConfiguration:
+        """
+        Get the configuration for the test
+        """
+        if self.__config is None:
+            raise RuntimeError(
+                "Test configuration not set. "
+                "A configuration is required to run integration tests."
+            )
+        return self.__config
+
+    @config.setter
+    def config(self, value: TestConfiguration):
+        """
+        Set the configuration for the test
+        """
+        self.__config = value
+
+    @property
+    def results(self) -> List[IntegrationTestResponse]:
+        """
+        Get the results of the test
+        """
+        return self.__results
+
+    def success(self) -> bool:
+        """
+        Returns True if all tests in the suite were successful
+        """
+        return all([result.success for result in self.results])
+
+    def test(self) -> bool:
+        """
+        Run the Test
+        Args:
+            config: The Test Configuration
+        Returns:
+            True if the test was successful, False otherwise.  If any
+            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.")

aplos_nca_saas_sdk-0.0.3/src/aplos_nca_saas_sdk/integration_testing/integration_test_response.py

@@ -0,0 +1,28 @@
+"""
+Copyright 2024 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from typing import Dict, Any, Optional
+
+
+class IntegrationTestResponse:
+    """Integration Test Response"""
+
+    def __init__(self):
+        self.name: str = ""
+        self.meta: Dict[str, Any] = {}
+        self.response: Dict[str, Any] = {}
+        self.error: Optional[str] = None
+        self.success: bool = False
+
+    def to_dict(self) -> Dict[str, Any]:
+        """JSON Dictionary Object"""
+        return {
+            "name": self.name,
+            "meta": self.meta,
+            "response": self.response,
+            "error": self.error,
+            "success": self.success,
+        }

{aplos_nca_saas_sdk-0.0.2 → aplos_nca_saas_sdk-0.0.3}/src/aplos_nca_saas_sdk/integration_testing/integration_test_suite.py

@@ -12,6 +12,7 @@ from aplos_nca_saas_sdk.integration_testing.integration_test_factory import (
 from aplos_nca_saas_sdk.integration_testing.integration_test_base import (
     IntegrationTestBase,
 )
+from aplos_nca_saas_sdk.integration_testing.configs.config import TestConfiguration
 
 
 class IntegrationTestSuite:
@@ -22,63 +23,67 @@ class IntegrationTestSuite:
         self.verbose: bool = False
         self.raise_on_failure: bool = False
 
-    def test(self) -> bool:
+    def test(self, test_config: TestConfiguration) -> bool:
         """Run a full suite of integration tests"""
+
+        # reset the test results
+        self.test_results = []
+
         start_time: datetime = datetime.now(UTC)
         factory: IntegrationTestFactory = IntegrationTestFactory()
-        test_class: IntegrationTestBase | None = None
-        for test_class in factory.test_classes:
-            test_instance: IntegrationTestBase = test_class
-            test: Dict[str, Any] = {
-                "test_name": test_instance.name,
+        test: IntegrationTestBase | None = None
+        for test in factory.test_classes:
+            test.config = test_config
+            test_result: Dict[str, Any] = {
+                "test_name": test.name,
                 "success": True,
                 "error": None,
                 "start_time_utc": datetime.now(UTC),
                 "end_time_utc": None,
             }
             if self.verbose:
-                print(f"Running test class {test_instance.name}")
+                print(f"Running test class {test.name}")
             try:
-                results = test_instance.test()
-                test["results"] = results
-
+                success = test.test()
+                test_result["success"] = success
+                test_result["results"] = test.results
             except Exception as e:  # pylint: disable=broad-except
-                test["success"] = False
-                test["error"] = str(e)
+                test_result["success"] = False
+                test_result["error"] = str(e)
 
-            test["end_time_utc"] = datetime.now(UTC)
-            self.test_results.append(test)
+            test_result["end_time_utc"] = datetime.now(UTC)
+            self.test_results.append(test_result)
 
             if self.verbose:
-                if test["success"]:
-                    print(f"Test {test_instance.name} succeeded")
+                if test_result["success"]:
+                    print(f"Test {test.name} succeeded")
                 else:
-                    print(
-                        f"Test {test_instance.name} failed with error {test['error']}"
-                    )
+                    print(f"Test {test.name} failed with error {test_result['error']}")
         # find the failures
         failures = [test for test in self.test_results if not test["success"]]
+        self.__print_results(start_time, failures)
 
         # print the results
 
+        if self.raise_on_failure and len(failures) > 0:
+            count = len(failures)
+            print(f"{count} tests failed. Raising exception.")
+            raise RuntimeError(f"{count} tests failed")
+
+        return len(failures) == 0
+
+    def __print_results(self, start_time: datetime, failures: List[Dict[str, Any]]):
         print("Test Results:")
-        for test in self.test_results:
-            duration = test["end_time_utc"] - test["start_time_utc"]
+        for test_result in self.test_results:
+            duration = test_result["end_time_utc"] - test_result["start_time_utc"]
             print(
-                f"  {test['test_name']} {'succeeded' if test['success'] else 'failed'} duration: {duration}"
+                f"  {test_result['test_name']} {'succeeded' if test_result['success'] else 'failed'} duration: {duration}"
             )
-            if not test["success"]:
-                print(f"    Error: {test['error']}")
+            if not test_result["success"]:
+                print(f"    Error: {test_result['error']}")
 
         print(f"Test Suite completed in {datetime.now(UTC) - start_time}")
 
         print(f"Total Tests: {len(self.test_results)}")
         print(f"Successful Tests: {len(self.test_results) - len(failures)}")
         print(f"Failed Tests: {len(failures)}")
-
-        if self.raise_on_failure and len(failures) > 0:
-            count = len(failures)
-            print(f"{count} tests failed. Raising exception.")
-            raise RuntimeError(f"{count} tests failed")
-
-        return len(failures) == 0

{aplos_nca_saas_sdk-0.0.2 → aplos_nca_saas_sdk-0.0.3}/src/aplos_nca_saas_sdk/integration_testing/main.py

@@ -9,6 +9,7 @@ from aplos_nca_saas_sdk.utilities.environment_services import EnvironmentService
 from aplos_nca_saas_sdk.integration_testing.integration_test_suite import (
     IntegrationTestSuite,
 )
+from aplos_nca_saas_sdk.integration_testing.configs.config import TestConfiguration
 
 
 def main():
@@ -21,7 +22,20 @@ def main():
         evs.load_environment(starting_path=__file__, file_name=env_file)
 
     its: IntegrationTestSuite = IntegrationTestSuite()
-    its.test()
+    config: TestConfiguration = TestConfiguration()
+    username = os.getenv("TEST_USERNAME")
+    password = os.getenv("TEST_PASSWORD")
+    domain = os.getenv("TEST_DOMAIN")
+
+    if not username or not password or not domain:
+        raise RuntimeError(
+            "TEST_USERNAME, TEST_PASSWORD, and TEST_DOMAIN must be set in the environment"
+        )
+
+    config.logins.add(username=username, password=password, domain=domain)
+    config.app_config.domains.append(domain)
+
+    its.test(test_config=config)
 
 
 if __name__ == "__main__":