aplos-nca-saas-sdk 0.0.1__tar.gz

aplos_nca_saas_sdk-0.0.1/.gitignore

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

aplos_nca_saas_sdk-0.0.1/.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-0.0.1/.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-0.0.1/.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-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aplos_nca_saas_sdk-0.0.1/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.3
+Name: aplos_nca_saas_sdk
+Version: 0.0.1
+Summary: Aplos NCA SaaS SDK
+Author-email: Eric Wilson <eric.wilson@aplosanalytics.com>
+Classifier: License :: OSI Approved :: MIT 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 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
+
+> 🛑 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.
+
+
+## API
+You can use the API to integrate the Aplos NCA SaaS Cloud Solution into your workflow.
+
+## 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)
+
+
+

aplos_nca_saas_sdk-0.0.1/README.md

@@ -0,0 +1,33 @@
+# Aplos NCA SaaS SDK for python
+
+You can use 🐍 python to perform analysis with Aplos NCA using API calls via secure HTTPS requests.
+
+> 👉 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
+
+> 🛑 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.
+
+
+## API
+You can use the API to integrate the Aplos NCA SaaS Cloud Solution into your workflow.
+
+## 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)
+
+
+

aplos_nca_saas_sdk-0.0.1/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-0.0.1/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-0.0.1/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

aplos_nca_saas_sdk-0.0.1/devops/code_artifacts/main.py

@@ -0,0 +1,224 @@
+import json
+import os
+import shutil
+import subprocess
+from pathlib import Path
+from typing import List
+
+import toml
+from aws_lambda_powertools import Logger
+from devops.code_artifacts.environment_vars import envrionment_vars
+
+logger = Logger()
+
+
+class AWSCodeArtifactsService:
+    """AWS Code Artifactis"""
+
+    def __init__(self) -> None:
+        self.domain = envrionment_vars.code_artifact_domain
+        self.repository = envrionment_vars.code_artifact_repository_name
+        self.account = envrionment_vars.code_artifact_account_number
+        self.profile = envrionment_vars.code_artifact_repository_profile
+
+    def build(self):
+        """Build the artifacts"""
+
+        project_root = Path(__file__).parents[2]
+
+        # extact the version
+        pyproject_toml = os.path.join(project_root, "pyproject.toml")
+
+        if not os.path.exists(pyproject_toml):
+            raise RuntimeError(
+                f"The pyproject.toml file ({pyproject_toml}) not found. "
+                "Please check the path and try again."
+            )
+
+        # get the "packages" from the toml file
+        packages_path: str | None = None
+        with open(pyproject_toml, "r", encoding="utf-8") as file:
+            pyproject_data = toml.load(file)
+            packages_path = pyproject_data.get("project", {}).get("source")
+
+        if not packages_path:
+            raise RuntimeError(
+                "The packages path is not defined in the pyproject.toml file."
+            )
+        version_file = os.path.join(project_root, packages_path, "version.py")
+
+        self.extract_version_and_write_to_file(pyproject_toml, version_file)
+        # do the build
+        self.__run_local_clean_up(project_root)
+        self.__run_login()
+        self.__run_build()
+
+    def publish(self):
+        """Publish the artifacts"""
+        self.__run_publish()
+
+    def __run_local_clean_up(self, project_root: str):
+        """run a local clean up and remove older items in the dist directory"""
+
+        dist_dir = os.path.join(project_root, "dist")
+        if os.path.exists(dist_dir):
+            # clear it out
+            shutil.rmtree(dist_dir)
+
+    def run_remote_clean_up(self):
+        """
+        Clean out older versions
+        """
+        logger.warning("warning/info: older versions are not being cleaned out.")
+
+    def extract_version_and_write_to_file(self, pyproject_toml: str, version_file: str):
+        """
+        extract the version number from the pyproject.toml file and write it
+        to the version.py file
+        """
+        if not os.path.exists(pyproject_toml):
+            raise FileNotFoundError(
+                f"The pyproject.toml file ({pyproject_toml}) not found. "
+                "Please check the path and try again."
+            )
+
+        with open(pyproject_toml, "r", encoding="utf-8") as file:
+            pyproject_data = toml.load(file)
+            version = pyproject_data["project"]["version"]
+            with open(version_file, "w", encoding="utf-8") as f:
+                f.write(f"__version__ = '{version}'\n")
+
+    def __run_login(self):
+        """log into code artifact"""
+        profile_flag: str = ""
+
+        if self.profile:
+            profile_flag = f"--profile {self.profile}"
+        commands = f"aws codeartifact login --tool pip --domain {self.domain} --repository {self.repository} {profile_flag}".split()
+        self.run_commands(commands=commands)
+
+    def __run_build(self):
+        """Run python build commands"""
+        self.run_commands(["python", "-m", "build"])
+
+    def __run_publish(self):
+        """publish to code artifact"""
+        self.connect_artifact_to_twine()
+        repo_url = self.get_repo_url()
+
+        token = self.get_auth_token()
+        # Set up the environment variables for the upload command
+        env = os.environ.copy()
+        env["TWINE_USERNAME"] = "aws"
+        env["TWINE_PASSWORD"] = token
+
+        commands = [
+            "python",
+            "-m",
+            "twine",
+            "upload",
+            "--repository-url",
+            repo_url,
+        ]
+
+        # if self.profile:
+        #     commands.extend(["--profile", f"{self.profile}"])
+
+        commands.extend(["dist/*"])
+
+        self.run_commands(
+            commands=commands,
+            env=env,
+        )
+
+    def connect_artifact_to_twine(self) -> None:
+        """Connect twine to codeartifact"""
+        profile_flag = ""
+        if self.profile:
+            profile_flag = f"--profile {self.profile}"
+        commands = f"aws codeartifact login {profile_flag} --tool twine --domain {self.domain} --repository {self.repository}".split()
+        self.run_commands(commands=commands, capture_output=True)
+
+    def get_repo_url(self) -> str:
+        """get the artifact repo url"""
+        get_url_command = [
+            "aws",
+            "codeartifact",
+            "get-repository-endpoint",
+            "--domain",
+            self.domain,
+            "--domain-owner",
+            self.account,
+            "--repository",
+            self.repository,
+            "--format",
+            "pypi",
+        ]
+
+        if self.profile:
+            get_url_command.extend(["--profile", self.profile])
+
+        repo_url = self.run_commands(get_url_command, capture_output=True)
+
+        if not repo_url:
+            raise RuntimeError("Unable to get the repository url")
+        repo_url = self.get_url(repo_url)
+        return repo_url
+
+    def get_auth_token(self) -> str:
+        """get the auth token"""
+        commands = [
+            "aws",
+            "codeartifact",
+            "get-authorization-token",
+            "--domain",
+            self.domain,
+            "--domain-owner",
+            self.account,
+            "--query",
+            "authorizationToken",
+            "--output",
+            "text",
+        ]
+
+        token = self.run_commands(commands=commands, capture_output=True)
+
+        return token
+
+    def get_url(self, payload: str):
+        """get the url from the payload"""
+        value: dict = json.loads(payload)
+        url = value.get("repositoryEndpoint")
+
+        return url
+
+    def run_commands(
+        self, commands: List[str], capture_output: bool = False, env=None
+    ) -> str | None:
+        """centralized area for running process commands"""
+        try:
+            # Run the publish command
+            result = subprocess.run(
+                commands,
+                check=True,
+                capture_output=capture_output,
+                env=env,  # pass any environment vars
+            )
+
+            if capture_output:
+                output = result.stdout.decode().strip()
+                return output
+
+        except subprocess.CalledProcessError as e:
+            logger.exception(f"An error occurred: {e}")
+
+
+def main():
+    """build the artifacts"""
+    artifacts: AWSCodeArtifactsService = AWSCodeArtifactsService()
+    artifacts.build()
+    artifacts.publish()
+
+
+if __name__ == "__main__":
+    main()

aplos_nca_saas_sdk-0.0.1/devops/code_artifacts/pip_code_artifact_setup.py

@@ -0,0 +1,66 @@
+import os
+import subprocess
+from aws_lambda_powertools import Logger
+from devops.code_artifacts.environment_vars import envrionment_vars
+
+logger = Logger()
+
+
+def setup_codeartifact_pip(
+    account_number: str,
+    domain: str,
+    repository: str,
+    region: str,
+    profile: str | None = None,
+):
+    # Get the AWS account ID
+    # sts_client = boto3.client('sts')
+    # account_id = sts_client.get_caller_identity().get('Account')
+
+    # Authenticate pip with CodeArtifact
+    login_command = [
+        "aws",
+        "codeartifact",
+        "login",
+        "--tool",
+        "pip",
+        "--domain",
+        domain,
+        "--domain-owner",
+        account_number,
+        "--repository",
+        repository,
+        "--region",
+        region,
+    ]
+    if profile:
+        login_command.extend(["--profile", profile])
+
+    result = subprocess.run(login_command, capture_output=True, text=True, check=True)
+
+    if result.returncode != 0:
+        logger.error("Failed to authenticate pip with CodeArtifact.")
+        logger.error("Command output:", result.stdout)
+        logger.error("Error output:", result.stderr)
+        raise RuntimeError("CodeArtifact login failed")
+
+    logger.info("Successfully authenticated pip with CodeArtifact.")
+    logger.info("Command output:", result.stdout)
+
+    logger.info(
+        f"Configured pip to use CodeArtifact repository {repository} in domain {domain}."
+    )
+
+
+def main():
+    setup_codeartifact_pip(
+        account_number=envrionment_vars.code_artifact_account_number,
+        domain=envrionment_vars.code_artifact_domain,
+        repository=envrionment_vars.code_artifact_repository_name,
+        region=envrionment_vars.code_artifact_repository_region,
+        profile=envrionment_vars.code_artifact_repository_profile,
+    )
+
+
+if __name__ == "__main__":
+    main()