oak-cli 0.3.7__tar.gz → 0.3.9__tar.gz

{oak_cli-0.3.7 → oak_cli-0.3.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oak_cli
-Version: 0.3.7
+Version: 0.3.9
 Summary: 
 Author: Alexander Malyuk
 Author-email: malyuk.alexander1999@gmail.com

{oak_cli-0.3.7 → oak_cli-0.3.9}/oak_cli/configuration/auxiliary.py

@@ -1,23 +1,14 @@
 import pathlib
 import readline
 
+from oak_cli.configuration.common import get_config_value
+from oak_cli.configuration.keys.enums import ConfigurableConfigKey
 from oak_cli.utils.logging import logger
-from oak_cli.utils.types import CustomEnum
-
-
-class ConfigKey(CustomEnum):
-    CONFIG_MAIN_KEY = "OAK_CLI"
-    CONFIG_VERSION_KEY = "config_version"
-
-    LOCAL_MACHINE_PURPOSE_KEY = "local_machine_purpose"
-
-    MAIN_OAK_REPO_PATH_KEY = "main_oak_repo_path"
-    FLOPS_REPO_PATH_KEY = "flops_repo_path"
 
 
 def prompt_for_path(path_name: str) -> pathlib.Path:
     while True:
-        logger.info(f"Please provide the path to {path_name}")
+        logger.info(f"Please provide the '{path_name}'")
         # https://stackoverflow.com/questions/56119177/how-to-make-a-python-script-tab-complete-directories-in-terminal/56119373#56119373
         readline.set_completer_delims(" \t\n=")
         readline.parse_and_bind("tab: complete")
@@ -27,3 +18,7 @@ def prompt_for_path(path_name: str) -> pathlib.Path:
             continue
         break
     return user_typed_path
+
+
+def get_main_oak_repo_path() -> pathlib.Path:
+    return pathlib.Path(get_config_value(ConfigurableConfigKey.MAIN_OAK_REPO_PATH))

{oak_cli-0.3.7 → oak_cli-0.3.9}/oak_cli/configuration/common.py

@@ -1,9 +1,11 @@
+from __future__ import annotations
+
 import configparser
 import pathlib
 import sys
 from typing import Any, Optional
 
-from oak_cli.configuration.auxiliary import ConfigKey
+from oak_cli.configuration.keys.enums import ConfigKey, InternalConfigKey
 from oak_cli.utils.logging import logger
 
 OAK_CLI_CONFIG_PATH = pathlib.Path.home() / ".oak_cli_config"
@@ -17,12 +19,12 @@ def _check_local_config_valid() -> bool:
         return False
 
     config = open_local_config()
-    all_config_key_value_pairs = config.items(ConfigKey.CONFIG_MAIN_KEY.value)
+    all_config_key_value_pairs = config.items(InternalConfigKey.CONFIG_MAIN_KEY.value)
     all_config_elements = [elem for sublist in all_config_key_value_pairs for elem in sublist]
-    if ConfigKey.CONFIG_VERSION_KEY.value not in all_config_elements:
+    if InternalConfigKey.CONFIG_VERSION.value not in all_config_elements:
         return False
 
-    local_config_version = get_config_value(ConfigKey.CONFIG_VERSION_KEY)
+    local_config_version = get_config_value(InternalConfigKey.CONFIG_VERSION)
     return local_config_version == CONFIG_VERSION
 
 
@@ -34,12 +36,17 @@ def open_local_config() -> configparser.ConfigParser:
 
 def update_config_value(key: ConfigKey, value: Any) -> None:
     config = open_local_config()
-    config[ConfigKey.CONFIG_MAIN_KEY.value][key.value] = value
+    config[InternalConfigKey.CONFIG_MAIN_KEY.value][key.value] = value
     _update_config(config)
 
 
-def get_config_value(key: ConfigKey) -> Any:
-    return open_local_config()[ConfigKey.CONFIG_MAIN_KEY.value].get(key.value)
+def get_config_value(
+    key: ConfigKey, terminate_if_key_is_missing_from_conf: bool = True
+) -> Optional[str]:
+    value_from_config = open_local_config()[InternalConfigKey.CONFIG_MAIN_KEY.value].get(key.value)
+    if not value_from_config and terminate_if_key_is_missing_from_conf:
+        _handle_missing_key_access_attempt(key)
+    return value_from_config
 
 
 def _update_config(config: configparser.ConfigParser) -> None:
@@ -52,9 +59,9 @@ def _create_initial_unconfigured_config_file() -> None:
         OAK_CLI_CONFIG_PATH.touch()
 
     config = configparser.ConfigParser()
-    config[ConfigKey.CONFIG_MAIN_KEY.value] = {}
+    config[InternalConfigKey.CONFIG_MAIN_KEY.value] = {}
     _update_config(config=config)
-    update_config_value(key=ConfigKey.CONFIG_VERSION_KEY, value=CONFIG_VERSION)
+    update_config_value(key=InternalConfigKey.CONFIG_VERSION, value=CONFIG_VERSION)
     logger.info(
         "\n".join(
             (
@@ -73,17 +80,13 @@ def check_and_handle_config_file() -> None:
     _create_initial_unconfigured_config_file()
 
 
-def handle_missing_key_access_attempt(
-    config_string_key: Optional[str],
-    what_should_be_found: str,
-) -> None:
-    if not config_string_key:
-        logger.error(
-            "\n".join(
-                (
-                    f"The '{what_should_be_found}' was not found in your oak-CLI config.",
-                    "Please first configure it by running the matching oak-cli configuration cmd.",
-                )
+def _handle_missing_key_access_attempt(key: ConfigKey) -> None:
+    logger.error(
+        "\n".join(
+            (
+                f"The '{key.value.replace('_', ' ')}' was not found in your oak-CLI config.",
+                "Please first configure it by running the matching oak-cli configuration cmd.",
             )
         )
-        sys.exit(1)
+    )
+    sys.exit(1)

oak_cli-0.3.9/oak_cli/configuration/keys/enums.py

@@ -0,0 +1,31 @@
+import enum
+
+
+class ConfigKey:
+    pass
+
+
+class InternalConfigKey(ConfigKey, enum.Enum):
+    """Interal Config Keys are not configurable by the user of the CLI."""
+
+    CONFIG_MAIN_KEY = "OAK_CLI"
+    CONFIG_VERSION = "config_version"
+
+
+class ConfigurableConfigKey(ConfigKey, enum.Enum):
+    LOCAL_MACHINE_PURPOSE = "local_machine_purpose"
+
+    MAIN_OAK_REPO_PATH = "main_oak_repo_path"
+    FLOPS_REPO_PATH = "flops_repo_path"
+
+    SYSTEM_MANAGER_IP = "system_manager_ip"
+
+    CLUSTER_MANAGER_IP = "cluster_manager_ip"
+    CLUSTER_NAME = "cluster_name"
+    CLUSTER_LOCATION = "cluster_location"
+
+    def is_path(self) -> bool:
+        return self.value.endswith("_path")
+
+    def get_pleasant_name(self) -> str:
+        return self.value.replace("_", " ")

oak_cli-0.3.9/oak_cli/configuration/keys/main.py

@@ -0,0 +1,20 @@
+from typing import Optional
+
+import typer
+
+from oak_cli.configuration.auxiliary import prompt_for_path
+from oak_cli.configuration.common import check_and_handle_config_file, update_config_value
+from oak_cli.configuration.keys.enums import ConfigurableConfigKey
+
+app = typer.Typer()
+
+
+@app.command("configure", help="Configure a core variable.")
+def configure_config_key(key: ConfigurableConfigKey, value: Optional[str] = None) -> None:
+    check_and_handle_config_file()
+    if not value:
+        if key.is_path():
+            value = str(prompt_for_path(key.get_pleasant_name()))
+        else:
+            value = typer.prompt(f"What values should '{key.get_pleasant_name()}' have?")
+    update_config_value(key=key, value=value)

{oak_cli-0.3.7 → oak_cli-0.3.9}/oak_cli/configuration/local_machine_purpose.py

@@ -3,13 +3,12 @@ from typing import List, Optional
 
 import typer
 
-from oak_cli.configuration.auxiliary import ConfigKey
 from oak_cli.configuration.common import (
     check_and_handle_config_file,
     get_config_value,
-    handle_missing_key_access_attempt,
     update_config_value,
 )
+from oak_cli.configuration.keys.enums import ConfigurableConfigKey
 from oak_cli.utils.typer_augmentations import AliasGroup
 from oak_cli.utils.types import CustomEnum
 
@@ -34,15 +33,12 @@ def get_local_machine_purposes_from_config(
     terminate_if_key_is_missing_from_conf: bool = True,
 ) -> Optional[List[LocalMachinePurpose]]:
     check_and_handle_config_file()
-    config_json_string = get_config_value(ConfigKey.LOCAL_MACHINE_PURPOSE_KEY)
-    if terminate_if_key_is_missing_from_conf:
-        handle_missing_key_access_attempt(
-            config_string_key=config_json_string,
-            what_should_be_found="local machine purpose",
-        )
-    else:
-        if not config_json_string:
-            return
+    config_json_string = get_config_value(
+        ConfigurableConfigKey.LOCAL_MACHINE_PURPOSE,
+        terminate_if_key_is_missing_from_conf,
+    )
+    if not config_json_string:
+        return None
     config_list = json.loads(config_json_string)
     return [LocalMachinePurpose(purpose_name) for purpose_name in config_list]
 
@@ -78,7 +74,7 @@ def configure_local_machine_purpose(
         local_machine_purposes = [LocalMachinePurpose.EVERYTHING]
     check_and_handle_config_file()
     update_config_value(
-        key=ConfigKey.LOCAL_MACHINE_PURPOSE_KEY,
+        key=ConfigurableConfigKey.LOCAL_MACHINE_PURPOSE,
         # NOTE: The config only supports strings.
         value=json.dumps([purpose.value for purpose in local_machine_purposes]),
     )

{oak_cli-0.3.7 → oak_cli-0.3.9}/oak_cli/configuration/main.py

@@ -2,9 +2,8 @@ import pprint
 
 import typer
 
-import oak_cli.configuration.addon_repos
+import oak_cli.configuration.keys.main
 import oak_cli.configuration.local_machine_purpose
-import oak_cli.configuration.main_oak_repo
 import oak_cli.docker.cluster_orchestrator
 import oak_cli.docker.root_orchestrator
 from oak_cli.configuration.common import check_and_handle_config_file, open_local_config
@@ -19,14 +18,9 @@ app.add_typer(
 )
 
 app.add_typer(
-    typer_instance=oak_cli.configuration.main_oak_repo.app,
-    name="main-repo",
-    help="Configure the main Oakestra repository",
-)
-app.add_typer(
-    typer_instance=oak_cli.configuration.addon_repos.app,
-    name="addon-repos",
-    help="Configure addon repositories",
+    typer_instance=oak_cli.configuration.keys.main.app,
+    name="key-vars",
+    help="Configure OAK-CLI Key Variables",
 )
 
 

{oak_cli-0.3.7 → oak_cli-0.3.9}/oak_cli/docker/common.py

@@ -2,7 +2,7 @@ import json
 import pathlib
 import sys
 
-from oak_cli.configuration.main_oak_repo import get_main_oak_repo_path_from_config
+from oak_cli.configuration.auxiliary import get_main_oak_repo_path
 from oak_cli.docker.enums import OakestraDockerComposeService, RootOrchestratorService
 from oak_cli.utils.common import run_in_shell
 from oak_cli.utils.logging import logger
@@ -10,11 +10,11 @@ from oak_cli.utils.styling import create_spinner
 
 
 def get_root_orchestrator_docker_compose_file_path() -> pathlib.Path:
-    return get_main_oak_repo_path_from_config() / "root_orchestrator" / "docker-compose.yml"
+    return get_main_oak_repo_path() / "root_orchestrator" / "docker-compose.yml"
 
 
 def get_cluster_orchestrator_docker_compose_file_path() -> pathlib.Path:
-    return get_main_oak_repo_path_from_config() / "cluster_orchestrator" / "docker-compose.yml"
+    return get_main_oak_repo_path() / "cluster_orchestrator" / "docker-compose.yml"
 
 
 def check_docker_service_status(

{oak_cli-0.3.7 → oak_cli-0.3.9}/oak_cli/main.py

@@ -12,11 +12,12 @@ import oak_cli.docker.main as oak_docker
 import oak_cli.installer.main as oak_installer
 import oak_cli.services.main as oak_services
 import oak_cli.worker.main as oak_worker
+from oak_cli.configuration.common import check_and_handle_config_file, get_config_value
+from oak_cli.configuration.keys.enums import ConfigurableConfigKey
 from oak_cli.configuration.local_machine_purpose import (
     LocalMachinePurpose,
     check_if_local_machine_has_required_purposes,
 )
-from oak_cli.utils.common import get_env_var
 from oak_cli.utils.logging import logger
 from oak_cli.utils.typer_augmentations import AliasGroup, typer_help_text
 
@@ -102,7 +103,10 @@ def show_version():
 
 @app.command("api-docs", help="Shows a links to the Swagger api-docs for Oakestra.")
 def show_api_docs():
-    api_docs_link = f"http://{get_env_var('SYSTEM_MANAGER_URL')}:1000/api/docs"
+    check_and_handle_config_file()
+    api_docs_link = (
+        f"http://{get_config_value(ConfigurableConfigKey.SYSTEM_MANAGER_IP)}:1000/api/docs"
+    )
     logger.info(f"Oakestra root API docs: '{api_docs_link}'")
 
 

{oak_cli-0.3.7 → oak_cli-0.3.9}/oak_cli/worker/common.py

@@ -44,13 +44,13 @@ def stop_process(process_cmd: str, process_name: str) -> None:
         return
 
     cmd_res = run_in_shell(
-        shell_cmd=f"ps -aux | grep '{process_cmd}' | awk '{{print $2}}'",
+        shell_cmd=f"ps -aux | grep '{process_cmd}' | grep -v 'grep' | awk '{{print $2}}'",
         pure_shell=True,
         text=True,
     )
     pids = [line for line in cmd_res.stdout.split("\n") if line != ""]
     # NOTE: The grep cmd and the python subprocess call count as 2 processes in the list.
-    if len(pids) > 2:
+    if len(pids) > 0:
         # NOTE: Killing the first PID in the list should stop the main process.
         # Thus, triggering a chain of events to remove all connected processes too.
         run_in_shell(shell_cmd=f"sudo kill {pids[0]}")

{oak_cli-0.3.7 → oak_cli-0.3.9}/oak_cli/worker/node_engine.py

@@ -5,12 +5,14 @@ from typing import Optional
 import typer
 from typing_extensions import Annotated
 
+from oak_cli.configuration.auxiliary import get_main_oak_repo_path
+from oak_cli.configuration.common import get_config_value
+from oak_cli.configuration.keys.enums import ConfigurableConfigKey
 from oak_cli.configuration.local_machine_purpose import (
     LocalMachinePurpose,
     check_if_local_machine_has_required_purposes,
 )
-from oak_cli.configuration.main_oak_repo import get_main_oak_repo_path_from_config
-from oak_cli.utils.common import get_env_var, run_in_shell
+from oak_cli.utils.common import run_in_shell
 from oak_cli.utils.logging import logger
 from oak_cli.utils.typer_augmentations import AliasGroup
 from oak_cli.worker.common import ProcessStatus, get_process_status, stop_process
@@ -38,7 +40,14 @@ def start_node_engine(
         logger.info("The NodeEngine is already running.")
         return
 
-    cmd = f"{NODE_ENGINE_CMD_PREFIX} -p 6000 -p 10100 -a {get_env_var(name='SYSTEM_MANAGER_URL')}"
+    cmd = " ".join(
+        (
+            NODE_ENGINE_CMD_PREFIX,
+            "-p 6000 -p 10100",
+            "-a",
+            get_config_value(ConfigurableConfigKey.CLUSTER_MANAGER_IP),
+        )
+    )
     if use_ml_data_server_for_flops_addon_learner:
         cmd += " -l"
     run_in_shell(shell_cmd=cmd, capture_output=False, check=False)
@@ -67,15 +76,17 @@ if check_if_local_machine_has_required_purposes(
         help=f"rebuilds (and restarts) the {NODE_ENGINE_NAME}.",
     )
     def rebuild_node_engine(
-        architecture: Architecture = Architecture.AMD64, restart: bool = True
+        # NOTE: Theoretically this is wrong but it only works like this - typer is WIP after all.
+        architecture: Architecture = Architecture.AMD64.value,
+        restart: bool = True,
     ) -> None:
         if restart:
             stop_node_engine()
 
-        node_engine_build_path = get_main_oak_repo_path_from_config() / "go_node_engine" / "build"
+        node_engine_build_path = get_main_oak_repo_path() / "go_node_engine" / "build"
         os.chdir(node_engine_build_path)
-        run_in_shell(shell_cmd="./build.sh")
-        run_in_shell(shell_cmd=f". install.sh {architecture.value}")
+        run_in_shell(shell_cmd="bash build.sh")
+        run_in_shell(shell_cmd=f"bash install.sh {architecture.value}")
         logger.info("Successfully rebuild the NodeEngine.")
 
         if restart:

{oak_cli-0.3.7 → oak_cli-0.3.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "oak_cli"
-version = "0.3.7"
+version = "0.3.9"
 description = ""
 authors = ["Alexander Malyuk <malyuk.alexander1999@gmail.com>"]
 readme = "README.md"

oak_cli-0.3.7/oak_cli/configuration/addon_repos.py

@@ -1,38 +0,0 @@
-import pathlib
-
-import typer
-
-from oak_cli.configuration.auxiliary import ConfigKey, prompt_for_path
-from oak_cli.configuration.common import (
-    check_and_handle_config_file,
-    get_config_value,
-    handle_missing_key_access_attempt,
-    update_config_value,
-)
-from oak_cli.utils.typer_augmentations import AliasGroup
-
-app = typer.Typer(cls=AliasGroup)
-
-
-def get_flops_repo_path_from_config() -> pathlib.Path:
-    check_and_handle_config_file()
-    config_string = get_config_value(ConfigKey.FLOPS_REPO_PATH_KEY)
-    handle_missing_key_access_attempt(
-        config_string_key=config_string,
-        what_should_be_found="FLOps addon repository path",
-    )
-    return pathlib.Path(config_string)
-
-
-@app.command(
-    "configure",
-    help="Configure the path to the FLOps addon repo.",
-)
-def configure_main_oak_repo_path() -> None:
-    # NOTE: There is no support for paths as input params with proper autocomplete.
-    flops_repo = prompt_for_path(path_name="the main oakestra repository")
-    check_and_handle_config_file()
-    update_config_value(
-        key=ConfigKey.FLOPS_REPO_PATH_KEY,
-        value=str(flops_repo),
-    )

oak_cli-0.3.7/oak_cli/configuration/main_oak_repo.py

@@ -1,38 +0,0 @@
-import pathlib
-
-import typer
-
-from oak_cli.configuration.auxiliary import ConfigKey, prompt_for_path
-from oak_cli.configuration.common import (
-    check_and_handle_config_file,
-    get_config_value,
-    handle_missing_key_access_attempt,
-    update_config_value,
-)
-from oak_cli.utils.typer_augmentations import AliasGroup
-
-app = typer.Typer(cls=AliasGroup)
-
-
-def get_main_oak_repo_path_from_config() -> pathlib.Path:
-    check_and_handle_config_file()
-    config_string = get_config_value(ConfigKey.MAIN_OAK_REPO_PATH_KEY)
-    handle_missing_key_access_attempt(
-        config_string_key=config_string,
-        what_should_be_found="main oakestra repository path",
-    )
-    return pathlib.Path(config_string)
-
-
-@app.command(
-    "configure",
-    help="Configure the path to the main oakestra repo.",
-)
-def configure_main_oak_repo_path() -> None:
-    # NOTE: There is no support for paths as input params with proper autocomplete.
-    main_oak_repo = prompt_for_path(path_name="the main oakestra repository")
-    check_and_handle_config_file()
-    update_config_value(
-        key=ConfigKey.MAIN_OAK_REPO_PATH_KEY,
-        value=str(main_oak_repo),
-    )