aplos-nca-saas-sdk 1.0.0__tar.gz

aplos_nca_saas_sdk-1.0.0/.gitignore

@@ -0,0 +1,13 @@
+
+.venv/
+dist/
+.DS_Store
+.env
+*.pyc
+
+.coverage
+
+.imports/
+# don't track environment files
+.env
+.env.*

aplos_nca_saas_sdk-1.0.0/.pypirc

@@ -0,0 +1,7 @@
+[distutils]
+index-servers =
+    codeartifact
+
+[codeartifact]
+repository =  https://aplos-nca-974817967438.d.codeartifact.us-east-1.amazonaws.com/pypi/python/
+username = aws

aplos_nca_saas_sdk-1.0.0/.vscode/launch.json

@@ -0,0 +1,57 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "env": {
+                
+                "ENVRIONMENT": "dev",
+                "DEBUG_MODE": "True",
+                "PYTHONPATH": "${workspaceFolder}:${workspaceFolder}/src:${workspaceFolder}/devops:${workspaceFolder}:${workspaceFolder}/tests"
+            }
+        },
+        {
+            "name": "Build & Deploy To PyPi",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/devops/pypi/build.py",
+            "console": "integratedTerminal"
+        },
+
+        {
+            "name": "Build & Deploy To Code Artifacts",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/devops/code_artifacts/main.py",
+            "console": "integratedTerminal",
+            "env": {
+                
+                "ENVRIONMENT": "dev",
+                "DEBUG_MODE": "True",
+                "PYTHONPATH": "${workspaceFolder}:${workspaceFolder}/src:${workspaceFolder}/devops:"
+            }
+        },
+        {
+            "name": "Run Integration Tests - dev",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/src/aplos_nca_saas_sdk/integration_testing/main.py",
+            "console": "integratedTerminal",
+            "env": {
+                
+                "ENVRIONMENT": "dev",
+                "ENV_FILE": ".env.development",
+                "DEBUG_MODE": "True",
+                "PYTHONPATH": "${workspaceFolder}:${workspaceFolder}/src:${workspaceFolder}/devops:${workspaceFolder}/devops"                                           
+            }
+        },
+        
+    ]
+}

aplos_nca_saas_sdk-1.0.0/.vscode/settings.json

@@ -0,0 +1,35 @@
+{
+    
+    "python.testing.pytestEnabled": false,
+    "python.testing.unittestEnabled": true,
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./tests",
+        "-p",
+        "*_test.py"
+    ],
+    "python.testing.cwd": "${workspaceFolder}",
+    "python.analysis.extraPaths": [                
+        "${workspaceFolder}/src",
+        "${workspaceFolder}/src/aplos_nca_saas_sdk",        
+        "${workspaceFolder}/tests",
+        "${workspaceFolder}/devops",
+        "${workspaceFolder}/devops/cdk",
+    
+    ],
+    "python.analysis.typeCheckingMode": "off",
+    "pylint.args": [
+        "--max-line-length=150"
+    ],
+    "[python]": {
+        
+        "editor.formatOnSave": true,
+        // "editor.codeActionsOnSave": {
+        //     "source.fixAll": "explicit",
+        //     "source.organizeImports": "explicit"
+        // },
+        "editor.defaultFormatter": "charliermarsh.ruff",
+    },
+    
+}

aplos_nca_saas_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.3
+Name: aplos_nca_saas_sdk
+Version: 1.0.0
+Summary: Aplos NCA SaaS SDK
+Author-email: Eric Wilson <eric.wilson@aplosanalytics.com>
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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
+
+You can use 🐍 python to perform analysis with Aplos NCA using API calls via secure HTTPS requests. We have prepared sample scripts to illustrate how this analysis can be performed using python. 
+
+This was created as a reusable library which was wrapped with commandline parsing.  You can use command line switches or simply run it and get prompted for the required input.
+
+All the source code can be downloaded from our [docs repo](https://github.com/AplosAnalytics/docs.aplosanalytics.com/tree/main/docs/samples/python/aplos_nca).
+
+>[!TIP] We use this for our demos
+> We'll keep this maintained as we use it for our customer demos.  So keep coming back for new features.
+
+
+## API Settings
+
+> [!WARNING] 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.
+>
+> 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.  
+> 
+> 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.
+
+### Access your settings from the UI
+![API Configuration](/docs/images/API_Configuration_blur.png)
+
+
+## Python Environment
+While it's not required, we suggest setting up a virtual environment with your favorite tool.
+
+Example.  From the project root issue the following command (in mac, linux or windows shell subsystem)
+```shell
+python -m venv .venv
+source ./.venv/bin/activate
+```
+
+Install the required packages 
+```shell
+# (from the project root)
+pip install -r ./docs/samples/python/aplos_nca/requirements.txt
+
+# or if you are in the aplos_nca directory
+pip install -r ./requirements.txt
+```
+
+
+## Required Files for execution (analysis submission)
+To submit something for an analysis, you will need 2 required files and one optional file.  
+- Input File (analysis file)
+- Configuration File (configurations on how to run the analysis)
+- Meta Data (optional)
+
+Technically only the analysis file is submitted as a file.  
+
+The other two (configuration and metadata) are submitted as JSON/dictionary objects.  However to make things easier for this demo they are stored as files, then read in at runtime and submitted in their normal dictionary form.
+
+The files are located `./files` directory of this demo project (`./samples/python/aplos_nca`).
+
+
+## Outputs
+Currently, we are outputting the files in a hidden directory (`.output`) which is also excluded from the git commits.  This can easily be overridden to your choosing.
+
+Located in `./.output`
+
+
+## Run the Execution
+
+In order to run the execution you need to either:
+- Add environment variables for the required parameter see [Environment Vars](/docs/samples/python-overview.html#environment-vars) later in this document
+- Use the command switch arguments
+- Or simply input the values as you are prompted.
+
+> [!TIP] Tip! Use environment vars and override when needed.
+> You can set the environment variables, but still override them during the prompts
+
+From the project you you can 
+`python .<project-path>/main.py`
+
+or navigate to the folder
+`python ./main.py`
+
+## Arguments
+
+|short|long|description|
+|---|---|---|
+|-s|--skip|Skip prompts if required values have defaults|
+|-u|--username|Your login username|
+|-p|--password|Your login password|
+|-f|--analyis-file|Path to the analysis file|
+|-c|--config-file|Path to the configuration file|
+|-m|--metadata-file|Path to the metadata file|
+|-a|--api-url|The api url|
+|-i|--client-id|The client id to cognito|
+|-o|-output-directory|The full path to an output directory. If one isn't provided it will default to a local (.aplos-nca-output) directory one level up from the execution directory. |
+|-e|--environment-file|The full path to an environment file (.env file).|
+
+### The `-s` argument (skipping prompts when defaults are available)
+If you have default values specified in code or a `.env` file, specify the `-s` will skip prompting for any parameters that are required but have an associated matching default value.
+
+
+### Scripting
+You can create scripts to launch several analyses by providing the runtime arguments. WARNING: you should be careful when exposing your username and password to others.
+For automation, it's best to store them as a secret and retrieve the secret at runtime.
+
+
+## Examples:
+Let's assume you have your username, password, and API settings in environment vars.  You can use the `-s` to skip those prompts and supply the config, meta, and analysis for different runs.
+
+> [!TIP]
+> If you have certain values present the command line tool will prompt to see if you want to use the defaults or override them.
+> If you want to skip the prompt, use `-s` as an argument.  This will skip the prompt for any value already set.
+
+### Sample execution
+
+If your username, password, client key and API URL are already set, then the only thing you need to do on each run is supply the configuration and the analysis file.  The meta-data file is optional.  Issuing the `-s` will skip all the extra prompts.
+
+```shell
+# single line execution example
+
+python main.py -s -c <config-file> -f <analysis-file> -m <meta-file>
+
+```
+
+### Same example, on multiple lines and with example files
+
+```shell
+
+# break into multiple lines for easier readability
+# NOTE: a copy paste of this from code samples doesn't always work right
+
+python ./main.py \
+    -s \
+    -f ./files/single_ev.csv \
+    -c ./files/configuration_single_ev.json \
+    -m ./files/meta_data.json
+
+```
+
+## Environment Vars
+
+To save time and typing you can use environment variables to "pre-load" your execution and then any "unknown" value will be asked by the command line utility.
+
+The following environment variables are required for execution.  We're using environment vars so that nothing gets accidentally saved into git.
+
+If executing the functions via the command line, you need to create the environment variables so that they are available at runtime, like the following.
+
+Mac & Linux
+```shell
+export APLOS_API_DOMAIN="<api-gateway-url>"
+export COGNITO_CLIENT_ID="<client-id>"
+export COGNITO_USER_NAME="<email-address>"
+export COGNITO_PASSWORD="<password>"
+export COGNITO_REGION="<region>"
+```
+Windows
+```shell
+SET APLOS_API_DOMAIN="<api-gateway-url>"
+SET COGNITO_CLIENT_ID="<client-id>"
+SET COGNITO_USER_NAME="<email-address>"
+SET COGNITO_PASSWORD="<password>"
+SET COGNITO_REGION="<region>"
+```
+
+> [!TIP]
+> You can also create a `.env` file locally and enter the environment vars there.
+
+```shell
+APLOS_API_DOMAIN="<api-gateway-url>"
+COGNITO_CLIENT_ID="<client-id>"
+COGNITO_USER_NAME="<email-address>"
+COGNITO_PASSWORD="<password>"
+COGNITO_REGION="<region>"
+```
+
+## The Command Line in Action
+In this example, I have all my settings preloaded in environment vars and I just hit enter several times to accept the defaults.
+
+![Commandline App](/docs/images/aplos-nca-commandline-cropped.png)

aplos_nca_saas_sdk-1.0.0/README.md

@@ -0,0 +1,179 @@
+# Aplos NCA SaaS SDK for python
+
+You can use 🐍 python to perform analysis with Aplos NCA using API calls via secure HTTPS requests. We have prepared sample scripts to illustrate how this analysis can be performed using python. 
+
+This was created as a reusable library which was wrapped with commandline parsing.  You can use command line switches or simply run it and get prompted for the required input.
+
+All the source code can be downloaded from our [docs repo](https://github.com/AplosAnalytics/docs.aplosanalytics.com/tree/main/docs/samples/python/aplos_nca).
+
+>[!TIP] We use this for our demos
+> We'll keep this maintained as we use it for our customer demos.  So keep coming back for new features.
+
+
+## API Settings
+
+> [!WARNING] 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.
+>
+> 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.  
+> 
+> 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.
+
+### Access your settings from the UI
+![API Configuration](/docs/images/API_Configuration_blur.png)
+
+
+## Python Environment
+While it's not required, we suggest setting up a virtual environment with your favorite tool.
+
+Example.  From the project root issue the following command (in mac, linux or windows shell subsystem)
+```shell
+python -m venv .venv
+source ./.venv/bin/activate
+```
+
+Install the required packages 
+```shell
+# (from the project root)
+pip install -r ./docs/samples/python/aplos_nca/requirements.txt
+
+# or if you are in the aplos_nca directory
+pip install -r ./requirements.txt
+```
+
+
+## Required Files for execution (analysis submission)
+To submit something for an analysis, you will need 2 required files and one optional file.  
+- Input File (analysis file)
+- Configuration File (configurations on how to run the analysis)
+- Meta Data (optional)
+
+Technically only the analysis file is submitted as a file.  
+
+The other two (configuration and metadata) are submitted as JSON/dictionary objects.  However to make things easier for this demo they are stored as files, then read in at runtime and submitted in their normal dictionary form.
+
+The files are located `./files` directory of this demo project (`./samples/python/aplos_nca`).
+
+
+## Outputs
+Currently, we are outputting the files in a hidden directory (`.output`) which is also excluded from the git commits.  This can easily be overridden to your choosing.
+
+Located in `./.output`
+
+
+## Run the Execution
+
+In order to run the execution you need to either:
+- Add environment variables for the required parameter see [Environment Vars](/docs/samples/python-overview.html#environment-vars) later in this document
+- Use the command switch arguments
+- Or simply input the values as you are prompted.
+
+> [!TIP] Tip! Use environment vars and override when needed.
+> You can set the environment variables, but still override them during the prompts
+
+From the project you you can 
+`python .<project-path>/main.py`
+
+or navigate to the folder
+`python ./main.py`
+
+## Arguments
+
+|short|long|description|
+|---|---|---|
+|-s|--skip|Skip prompts if required values have defaults|
+|-u|--username|Your login username|
+|-p|--password|Your login password|
+|-f|--analyis-file|Path to the analysis file|
+|-c|--config-file|Path to the configuration file|
+|-m|--metadata-file|Path to the metadata file|
+|-a|--api-url|The api url|
+|-i|--client-id|The client id to cognito|
+|-o|-output-directory|The full path to an output directory. If one isn't provided it will default to a local (.aplos-nca-output) directory one level up from the execution directory. |
+|-e|--environment-file|The full path to an environment file (.env file).|
+
+### The `-s` argument (skipping prompts when defaults are available)
+If you have default values specified in code or a `.env` file, specify the `-s` will skip prompting for any parameters that are required but have an associated matching default value.
+
+
+### Scripting
+You can create scripts to launch several analyses by providing the runtime arguments. WARNING: you should be careful when exposing your username and password to others.
+For automation, it's best to store them as a secret and retrieve the secret at runtime.
+
+
+## Examples:
+Let's assume you have your username, password, and API settings in environment vars.  You can use the `-s` to skip those prompts and supply the config, meta, and analysis for different runs.
+
+> [!TIP]
+> If you have certain values present the command line tool will prompt to see if you want to use the defaults or override them.
+> If you want to skip the prompt, use `-s` as an argument.  This will skip the prompt for any value already set.
+
+### Sample execution
+
+If your username, password, client key and API URL are already set, then the only thing you need to do on each run is supply the configuration and the analysis file.  The meta-data file is optional.  Issuing the `-s` will skip all the extra prompts.
+
+```shell
+# single line execution example
+
+python main.py -s -c <config-file> -f <analysis-file> -m <meta-file>
+
+```
+
+### Same example, on multiple lines and with example files
+
+```shell
+
+# break into multiple lines for easier readability
+# NOTE: a copy paste of this from code samples doesn't always work right
+
+python ./main.py \
+    -s \
+    -f ./files/single_ev.csv \
+    -c ./files/configuration_single_ev.json \
+    -m ./files/meta_data.json
+
+```
+
+## Environment Vars
+
+To save time and typing you can use environment variables to "pre-load" your execution and then any "unknown" value will be asked by the command line utility.
+
+The following environment variables are required for execution.  We're using environment vars so that nothing gets accidentally saved into git.
+
+If executing the functions via the command line, you need to create the environment variables so that they are available at runtime, like the following.
+
+Mac & Linux
+```shell
+export APLOS_API_DOMAIN="<api-gateway-url>"
+export COGNITO_CLIENT_ID="<client-id>"
+export COGNITO_USER_NAME="<email-address>"
+export COGNITO_PASSWORD="<password>"
+export COGNITO_REGION="<region>"
+```
+Windows
+```shell
+SET APLOS_API_DOMAIN="<api-gateway-url>"
+SET COGNITO_CLIENT_ID="<client-id>"
+SET COGNITO_USER_NAME="<email-address>"
+SET COGNITO_PASSWORD="<password>"
+SET COGNITO_REGION="<region>"
+```
+
+> [!TIP]
+> You can also create a `.env` file locally and enter the environment vars there.
+
+```shell
+APLOS_API_DOMAIN="<api-gateway-url>"
+COGNITO_CLIENT_ID="<client-id>"
+COGNITO_USER_NAME="<email-address>"
+COGNITO_PASSWORD="<password>"
+COGNITO_REGION="<region>"
+```
+
+## The Command Line in Action
+In this example, I have all my settings preloaded in environment vars and I just hit enter several times to accept the defaults.
+
+![Commandline App](/docs/images/aplos-nca-commandline-cropped.png)

aplos_nca_saas_sdk-1.0.0/devops/code_artifacts/check_and_setup.py

@@ -0,0 +1,44 @@
+import subprocess
+import sys
+import os
+from aws_lambda_powertools import Logger
+from devops.code_artifacts.environment_vars import envrionment_vars
+
+logger = Logger()
+
+
+def is_logged_in():
+    """Check to see if i'm logged in"""
+    try:
+        commands = ["aws", "codeartifact", "list-repositories"]
+        profile = envrionment_vars.code_artifact_repository_profile
+        if profile:
+            commands.append("--profile")
+            commands.append(profile)
+        result = subprocess.run(
+            commands,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            text=True,
+            check=True,
+        )
+        return result.returncode == 0
+    except Exception as e:  # pylint: disable=w0718
+        logger.exception(f"Error checking login status: {e}")
+        return False
+
+
+def run_setup():
+    """Run the setup"""
+    try:
+        subprocess.check_call([sys.executable, "./devops/pip_code_artifact_setup.py"])
+    except subprocess.CalledProcessError as e:
+        logger.exception(f"Setup script failed: {e}")
+        sys.exit(1)
+
+
+if not is_logged_in():
+    logger.info("Not logged in to CodeArtifact. Running setup script...")
+    run_setup()
+else:
+    logger.info("Already logged in to CodeArtifact.")

aplos_nca_saas_sdk-1.0.0/devops/code_artifacts/environment_vars.py

@@ -0,0 +1,36 @@
+import os
+
+
+class EnvironmentVars:
+    """Environment variables"""
+
+    def __init__(self):
+        pass
+
+    @property
+    def code_artifact_account_number(self):
+        """Gets thd code artifacti account number"""
+        return os.getenv("CODEARTIFACT_AWS_ACCCOUNT_NUMBER")  # "974817967438"
+
+    @property
+    def code_artifact_domain(self):
+        """Gets the code artifact domain"""
+        return os.getenv("CODEARTIFACT_DOMAIN")  # "aplos-nca"
+
+    @property
+    def code_artifact_repository_name(self):
+        """Gets the code artifact repository name"""
+        return os.getenv("CODEARTIFACT_REPOSITORY_NAME")  # "python"
+
+    @property
+    def code_artifact_repository_region(self):
+        """Gets the code artifact repository region"""
+        return os.getenv("CODEARTIFACT_REPOSITORY_REGION")  # "us-east-1"
+
+    @property
+    def code_artifact_repository_profile(self):
+        """Gets the code artifact repository profile"""
+        return os.getenv("CODEARTIFACT_REPOSITORY_PROFILE")
+
+
+envrionment_vars = EnvironmentVars()

aplos_nca_saas_sdk-1.0.0/devops/code_artifacts/local_test_support.py

@@ -0,0 +1,68 @@
+import os
+import json
+from typing import Optional
+from pathlib import Path
+from dotenv import load_dotenv
+from aws_lambda_powertools import Logger
+
+logger = Logger()
+
+
+class LocalTestingSupport:
+    def __init__(self) -> None:
+        pass
+
+    def load_local_environment(
+        self, *, path: Optional[str] = None, file_name: str = ".env.development"
+    ):
+        """Loads the local environment"""
+        environment_file: str | None = None
+        if path:
+            environment_file = os.path.join(path, file_name)
+        else:
+            environment_file = self.__find_env_file(file_name)
+
+        if environment_file is None:
+            raise RuntimeError(f"Failed to locate evnrionment file: {file_name}")
+
+        if os.path.exists(environment_file):
+            logger.debug(f"loading profile: {environment_file}")
+            load_dotenv(environment_file, override=True)
+
+            aws_profile = os.getenv("AWS_PROFILE")
+            logger.debug(f"aws_profile: {aws_profile}")
+        else:
+            raise RuntimeError(
+                f"Failed to locate evnrionment file: {file_name} at {environment_file}"
+            )
+
+    def __find_env_file(self, file_name: str) -> Optional[str]:
+        """Finds the environment file"""
+        for i in range(10):
+            path = str(Path(__file__).parents[i].absolute())
+            env_file = os.path.join(path, file_name)
+            if os.path.exists(env_file):
+                return env_file
+
+        return None
+
+    def load_event_file(self, full_path: str) -> dict:
+        """Loads an event file"""
+        if not os.path.exists(full_path):
+            raise RuntimeError(f"Failed to locate event file: {full_path}")
+
+        event: dict = {}
+        with open(full_path, mode="r", encoding="utf-8") as json_file:
+            event = json.load(json_file)
+
+        if "message" in event:
+            tmp = event.get("message")
+            if isinstance(tmp, dict):
+                event = tmp
+
+        if "event" in event:
+            tmp = event.get("event")
+            if isinstance(tmp, dict):
+                event = tmp
+
+        return event