cosmotech-acceleration-library 1.0.1__py3-none-any.whl → 2.0.0__py3-none-any.whl

cosmotech/csm_data/commands/api/runtemplate_load_handler.py

@@ -1,66 +0,0 @@
-# Copyright (C) - 2023 - 2025 - Cosmo Tech
-# This document and all information contained herein is the exclusive property -
-# including all intellectual property rights pertaining thereto - of Cosmo Tech.
-# Any use, reproduction, translation, broadcasting, transmission, distribution,
-# etc., to any person is prohibited unless it has been previously and
-# specifically authorized by written means by Cosmo Tech.
-
-from cosmotech.csm_data.utils.click import click
-from cosmotech.csm_data.utils.decorators import web_help, translate_help
-from cosmotech.orchestrator.utils.translate import T
-
-
-@click.command()
-@web_help("csm-data/api/runtemplate-load-handler")
-@translate_help("csm_data.commands.api.runtemplate_load_handler.description")
-@click.option(
-    "--organization-id",
-    envvar="CSM_ORGANIZATION_ID",
-    show_envvar=True,
-    help=T("csm_data.commands.api.runtemplate_load_handler.parameters.organization_id"),
-    metavar="o-##########",
-    required=True,
-)
-@click.option(
-    "--workspace-id",
-    envvar="CSM_WORKSPACE_ID",
-    show_envvar=True,
-    help=T("csm_data.commands.api.runtemplate_load_handler.parameters.workspace_id"),
-    metavar="w-##########",
-    required=True,
-)
-@click.option(
-    "--run-template-id",
-    envvar="CSM_RUN_TEMPLATE_ID",
-    show_envvar=True,
-    help=T("csm_data.commands.api.runtemplate_load_handler.parameters.run_template_id"),
-    metavar="NAME",
-    required=True,
-)
-@click.option(
-    "--handler-list",
-    envvar="CSM_CONTAINER_MODE",
-    show_envvar=True,
-    help=T("csm_data.commands.api.runtemplate_load_handler.parameters.handler_list"),
-    metavar="HANDLER,...,HANDLER",
-    required=True,
-)
-def runtemplate_load_handler(workspace_id, organization_id, run_template_id, handler_list):
-    # Import the function at the start of the command
-    from cosmotech.coal.cosmotech_api import load_run_template_handlers
-
-    try:
-        success = load_run_template_handlers(
-            organization_id=organization_id,
-            workspace_id=workspace_id,
-            run_template_id=run_template_id,
-            handler_list=handler_list,
-        )
-        if not success:
-            raise click.Abort()
-    except ValueError:
-        raise click.Abort()
-
-
-if __name__ == "__main__":
-    runtemplate_load_handler()

cosmotech/csm_data/commands/api/tdl_load_files.py

@@ -1,76 +0,0 @@
-# Copyright (C) - 2023 - 2025 - Cosmo Tech
-# This document and all information contained herein is the exclusive property -
-# including all intellectual property rights pertaining thereto - of Cosmo Tech.
-# Any use, reproduction, translation, broadcasting, transmission, distribution,
-# etc., to any person is prohibited unless it has been previously and
-# specifically authorized by written means by Cosmo Tech.
-
-from cosmotech.csm_data.utils.click import click
-from cosmotech.csm_data.utils.decorators import web_help, translate_help
-from cosmotech.orchestrator.utils.translate import T
-
-
-@click.command()
-@click.option(
-    "--organization-id",
-    envvar="CSM_ORGANIZATION_ID",
-    help=T("csm_data.commands.api.tdl_load_files.parameters.organization_id"),
-    metavar="o-XXXXXXXX",
-    type=str,
-    show_envvar=True,
-    required=True,
-)
-@click.option(
-    "--workspace-id",
-    envvar="CSM_WORKSPACE_ID",
-    help=T("csm_data.commands.api.tdl_load_files.parameters.workspace_id"),
-    metavar="w-XXXXXXXX",
-    type=str,
-    show_envvar=True,
-    required=True,
-)
-@click.option(
-    "--scenario-id",
-    envvar="CSM_SCENARIO_ID",
-    help=T("csm_data.commands.api.tdl_load_files.parameters.scenario_id"),
-    metavar="s-XXXXXXXX",
-    type=str,
-    show_envvar=True,
-    required=False,
-)
-@click.option(
-    "--runner-id",
-    envvar="CSM_RUNNER_ID",
-    help=T("csm_data.commands.api.tdl_load_files.parameters.runner_id"),
-    metavar="r-XXXXXXXX",
-    type=str,
-    show_envvar=True,
-    required=False,
-)
-@click.option(
-    "--dir",
-    "directory_path",
-    help=T("csm_data.commands.api.tdl_load_files.parameters.dir"),
-    metavar="PATH",
-    default="./",
-    type=str,
-    envvar="CSM_DATASET_ABSOLUTE_PATH",
-    show_envvar=True,
-    required=True,
-)
-@web_help("csm-data/api/tdl-load-file")
-@translate_help("csm_data.commands.api.tdl_load_files.description")
-def tdl_load_files(organization_id, workspace_id, scenario_id, runner_id, directory_path):
-    # Import the function at the start of the command
-    from cosmotech.coal.cosmotech_api import load_files_from_tdl
-
-    try:
-        load_files_from_tdl(
-            organization_id=organization_id,
-            workspace_id=workspace_id,
-            directory_path=directory_path,
-            runner_id=runner_id,
-            scenario_id=scenario_id,
-        )
-    except ValueError as e:
-        raise click.Abort() from e

cosmotech/csm_data/commands/api/tdl_send_files.py

@@ -1,82 +0,0 @@
-# Copyright (C) - 2023 - 2025 - Cosmo Tech
-# This document and all information contained herein is the exclusive property -
-# including all intellectual property rights pertaining thereto - of Cosmo Tech.
-# Any use, reproduction, translation, broadcasting, transmission, distribution,
-# etc., to any person is prohibited unless it has been previously and
-# specifically authorized by written means by Cosmo Tech.
-
-from cosmotech.csm_data.utils.click import click
-from cosmotech.csm_data.utils.decorators import web_help, translate_help
-from cosmotech.orchestrator.utils.translate import T
-
-
-@click.command()
-@click.option(
-    "--api-url",
-    envvar="CSM_API_URL",
-    help=T("csm_data.commands.api.tdl_send_files.parameters.api_url"),
-    metavar="URI",
-    type=str,
-    show_envvar=True,
-    required=True,
-)
-@click.option(
-    "--organization-id",
-    envvar="CSM_ORGANIZATION_ID",
-    help=T("csm_data.commands.api.tdl_send_files.parameters.organization_id"),
-    metavar="o-XXXXXXXX",
-    type=str,
-    show_envvar=True,
-    required=True,
-)
-@click.option(
-    "--workspace-id",
-    envvar="CSM_WORKSPACE_ID",
-    help=T("csm_data.commands.api.tdl_send_files.parameters.workspace_id"),
-    metavar="w-XXXXXXXX",
-    type=str,
-    show_envvar=True,
-    required=True,
-)
-@click.option(
-    "--runner-id",
-    envvar="CSM_RUNNER_ID",
-    help=T("csm_data.commands.api.tdl_send_files.parameters.runner_id"),
-    metavar="r-XXXXXXXX",
-    type=str,
-    show_envvar=True,
-    required=True,
-)
-@click.option(
-    "--dir",
-    "directory_path",
-    help=T("csm_data.commands.api.tdl_send_files.parameters.dir"),
-    metavar="PATH",
-    default="./",
-    type=str,
-    envvar="CSM_DATASET_ABSOLUTE_PATH",
-    show_envvar=True,
-    required=True,
-)
-@click.option(
-    "--clear/--keep",
-    help=T("csm_data.commands.api.tdl_send_files.parameters.clear"),
-    is_flag=True,
-    default=True,
-    show_default=True,
-    type=bool,
-)
-@web_help("csm-data/api/tdl-send-files")
-@translate_help("csm_data.commands.api.tdl_send_files.description")
-def tdl_send_files(api_url, organization_id, workspace_id, runner_id, directory_path, clear: bool):
-    # Import the function at the start of the command
-    from cosmotech.coal.cosmotech_api import send_files_to_tdl
-
-    send_files_to_tdl(
-        api_url=api_url,
-        organization_id=organization_id,
-        workspace_id=workspace_id,
-        runner_id=runner_id,
-        directory_path=directory_path,
-        clear=clear,
-    )

cosmotech/orchestrator_plugins/csm-data/templates/api/rds_load_csv.json

@@ -1,27 +0,0 @@
-{
-  "id": "csm-data rds-load-csv",
-  "command": "csm-data",
-  "arguments": [
-    "api",
-    "rds-load-csv"
-  ],
-  "description": "Use csm-data to query the results api and store it in a csv file, you need to add your arguments for filename and query while using this template",
-  "useSystemEnvironment": true,
-  "environment": {
-    "CSM_DATASET_ABSOLUTE_PATH": {
-      "description": "Target folder in which to write the resulting CSV file"
-    },
-    "CSM_ORGANIZATION_ID": {
-      "description": "An organization id for the Cosmo Tech API"
-    },
-    "CSM_WORKSPACE_ID": {
-      "description": "A workspace id for the Cosmo Tech API"
-    },
-    "CSM_RUNNER_ID": {
-      "description": "A runner id for the Cosmo Tech API"
-    },
-    "CSM_RUN_ID": {
-      "description": "A run id for the Cosmo Tech API"
-    }
-  }
-}

cosmotech/orchestrator_plugins/csm-data/templates/api/rds_send_csv.json

@@ -1,27 +0,0 @@
-{
-  "id": "csm-data rds-send-csv",
-  "command": "csm-data",
-  "arguments": [
-    "api",
-    "rds-send-csv"
-  ],
-  "description": "Use csm-data to send the content of all csv of a folder to the Cosmo Tech API as custom results data",
-  "useSystemEnvironment": true,
-  "environment": {
-    "CSM_DATASET_ABSOLUTE_PATH": {
-      "description": "Target folder in which to find CSV files to send to the Cosmo Tech API"
-    },
-    "CSM_ORGANIZATION_ID": {
-      "description": "An organization id for the Cosmo Tech API"
-    },
-    "CSM_WORKSPACE_ID": {
-      "description": "A workspace id for the Cosmo Tech API"
-    },
-    "CSM_RUNNER_ID": {
-      "description": "A runner id for the Cosmo Tech API"
-    },
-    "CSM_RUN_ID": {
-      "description": "A run id for the Cosmo Tech API"
-    }
-  }
-}

cosmotech/orchestrator_plugins/csm-data/templates/api/rds_send_store.json

@@ -1,27 +0,0 @@
-{
-  "id": "csm-data rds-send-store",
-  "command": "csm-data",
-  "arguments": [
-    "api",
-    "rds-send-store"
-  ],
-  "description": "Use csm-data to send the content of a store to the Cosmo Tech API as custom results data",
-  "useSystemEnvironment": true,
-  "environment": {
-    "CSM_PARAMETERS_ABSOLUTE_PATH": {
-      "description": "Folder containing the store to send to the Cosmo Tech API"
-    },
-    "CSM_ORGANIZATION_ID": {
-      "description": "An organization id for the Cosmo Tech API"
-    },
-    "CSM_WORKSPACE_ID": {
-      "description": "A workspace id for the Cosmo Tech API"
-    },
-    "CSM_RUNNER_ID": {
-      "description": "A runner id for the Cosmo Tech API"
-    },
-    "CSM_RUN_ID": {
-      "description": "A run id for the Cosmo Tech API"
-    }
-  }
-}

cosmotech/orchestrator_plugins/csm-data/templates/api/runtemplate_load_handler.json

@@ -1,27 +0,0 @@
-{
-  "id": "csm-data runtemplate-load-handler",
-  "command": "csm-data",
-  "arguments": [
-    "api",
-    "runtemplate-load-handler"
-  ],
-  "description": "Use csm-data to load run template handlers from the Cosmo Tech API",
-  "useSystemEnvironment": true,
-  "environment": {
-    "CSM_ORGANIZATION_ID": {
-      "description": "An organization id for the Cosmo Tech API"
-    },
-    "CSM_WORKSPACE_ID": {
-      "description": "A workspace id for the Cosmo Tech API"
-    },
-    "CSM_RUN_TEMPLATE_ID": {
-      "description": "A run template id for the Cosmo Tech API"
-    },
-    "CSM_CONTAINER_MODE": {
-      "description": "Comma-separated list of handlers to load"
-    },
-    "CSM_API_URL": {
-      "description": "The URL to a Cosmo Tech API instance"
-    }
-  }
-}

cosmotech/orchestrator_plugins/csm-data/templates/api/tdl_load_files.json

@@ -1,32 +0,0 @@
-{
-  "id": "csm-data tdl-load-files",
-  "command": "csm-data",
-  "arguments": [
-    "api",
-    "tdl-load-files"
-  ],
-  "description": "Use csm-data to query a twingraph and loads all the data from it",
-  "useSystemEnvironment": true,
-  "environment": {
-    "CSM_DATASET_ABSOLUTE_PATH": {
-      "description": "Target folder in which to write the resulting CSV files"
-    },
-    "CSM_API_URL": {
-      "description": "The URL to a Cosmo Tech API instance"
-    },
-    "CSM_ORGANIZATION_ID": {
-      "description": "An organization id for the Cosmo Tech API"
-    },
-    "CSM_WORKSPACE_ID": {
-      "description": "A workspace id for the Cosmo Tech API"
-    },
-    "CSM_SCENARIO_ID": {
-      "description": "A scenario id for the Cosmo Tech API",
-      "optional": true
-    },
-    "CSM_RUNNER_ID": {
-      "description": "A runner id for the Cosmo Tech API",
-      "optional": true
-    }
-  }
-}

cosmotech/orchestrator_plugins/csm-data/templates/api/tdl_send_files.json

@@ -1,27 +0,0 @@
-{
-  "id": "csm-data tdl-send-files",
-  "command": "csm-data",
-  "arguments": [
-    "api",
-    "tdl-send-files"
-  ],
-  "description": "Use csm-data to send a folder content to the Cosmo Tech API as a Twin Graph",
-  "useSystemEnvironment": true,
-  "environment": {
-    "CSM_DATASET_ABSOLUTE_PATH": {
-      "description": "Folder containing the files to send to the API"
-    },
-    "CSM_API_URL": {
-      "description": "The URL to a Cosmo Tech API instance"
-    },
-    "CSM_ORGANIZATION_ID": {
-      "description": "An organization id for the Cosmo Tech API"
-    },
-    "CSM_WORKSPACE_ID": {
-      "description": "A workspace id for the Cosmo Tech API"
-    },
-    "CSM_RUNNER_ID": {
-      "description": "A runner id for the Cosmo Tech API"
-    }
-  }
-}

cosmotech/translation/coal/en-US/coal/cosmotech_api/run_data.yml

@@ -1,2 +0,0 @@
-# Run Data-specific messages
-sending_to_table: "Sending data to table {table_name}"

cosmotech/translation/csm_data/en-US/csm_data/commands/api/rds_load_csv.yml

@@ -1,13 +0,0 @@
-description: |
-  Load data from a runner's RDS database into a CSV file.
-
-  Executes a SQL query against the runner's RDS database and saves the results to a CSV file.
-  By default, it will list all tables in the public schema if no specific query is provided.
-parameters:
-  target_folder: The folder where the csv will be written
-  organization_id: An organization id for the Cosmo Tech API
-  workspace_id: A workspace id for the Cosmo Tech API
-  runner_id: A runner id for the Cosmo Tech API
-  run_id: A run id for the Cosmo Tech API
-  file_name: A file name to write the query results
-  query: SQL query to execute (defaults to listing all tables in public schema)

cosmotech/translation/csm_data/en-US/csm_data/commands/api/rds_send_csv.yml

@@ -1,12 +0,0 @@
-description: |
-  Send CSV files to a runner's RDS database.
-
-  Takes all CSV files from a source folder and sends their content to the runner's RDS database.
-  Each CSV file will be sent to a table named after the file (without the .csv extension).
-  The table name will be prefixed with "CD_" in the database.
-parameters:
-  source_folder: The folder containing csvs to send
-  organization_id: An organization id for the Cosmo Tech API
-  workspace_id: A workspace id for the Cosmo Tech API
-  runner_id: A runner id for the Cosmo Tech API
-  run_id: A run id for the Cosmo Tech API

cosmotech/translation/csm_data/en-US/csm_data/commands/api/rds_send_store.yml

@@ -1,12 +0,0 @@
-description: |
-  Send data from a store to a runner's RDS database.
-
-  Takes all tables from a store and sends their content to the runner's RDS database.
-  Each table will be sent to a table with the same name, prefixed with "CD_" in the database.
-  Null values in rows will be removed before sending.
-parameters:
-  store_folder: The folder containing the store files
-  organization_id: An organization id for the Cosmo Tech API
-  workspace_id: A workspace id for the Cosmo Tech API
-  runner_id: A runner id for the Cosmo Tech API
-  run_id: A run id for the Cosmo Tech API

cosmotech/translation/csm_data/en-US/csm_data/commands/api/tdl_load_files.yml

@@ -1,14 +0,0 @@
-description: |
-  Query a twingraph and loads all the data from it
-
-  Will create 1 csv file per node type / relationship type
-
-  The twingraph must have been populated using the "tdl-send-files" command for this to work correctly
-
-  Requires a valid connection to the API to send the data
-parameters:
-  organization_id: An organization id for the Cosmo Tech API
-  workspace_id: A workspace id for the Cosmo Tech API
-  runner_id: A runner id for the Cosmo Tech API
-  scenario_id: A scenario id for the Cosmo Tech API
-  dir: Path to the directory to write the results to

cosmotech/translation/csm_data/en-US/csm_data/commands/api/tdl_send_files.yml

@@ -1,18 +0,0 @@
-description: |
-  Reads a folder CSVs and send those to the Cosmo Tech API as a Dataset
-
-  CSVs must follow a given format:
-    - Nodes files must have an id column
-    - Relationship files must have id, src and dest columns
-
-  Non-existing relationship (aka dest or src does not point to existing node) won't trigger an error,
-  the relationship will not be created instead.
-
-  Requires a valid connection to the API to send the data
-parameters:
-  api_url: The URI to a Cosmo Tech API instance
-  organization_id: An organization id for the Cosmo Tech API
-  workspace_id: A workspace id for the Cosmo Tech API
-  runner_id: A runner id for the Cosmo Tech API
-  dir: Path to the directory containing csvs to send
-  clear: Flag to clear the target dataset first (if set to True will clear the dataset before sending anything, irreversibly)