feat: initial version that requires comments for run_job

src/kiara/context/config.py

@@ -393,6 +393,7 @@ def create_default_store_config(
 
 
 class KiaraConfig(BaseSettings):
+
     model_config = SettingsConfigDict(
         env_prefix="kiara_", extra="forbid", use_enum_values=True
     )
@@ -890,18 +891,23 @@ def save(self, path: Union[Path, None] = None):
 
         path.parent.mkdir(parents=True, exist_ok=True)
 
+        data = self.model_dump(
+            exclude={
+                "context",
+                "auto_generate_contexts",
+                "stores_base_path",
+                "context_search_paths",
+                "default_context",
+                "runtime_config",
+            }
+        )
+
+        if data["default_store_type"] == DEFAULT_STORE_TYPE:
+            data.pop("default_store_type")
+
         with path.open("wt") as f:
             yaml.dump(
-                self.model_dump(
-                    exclude={
-                        "context",
-                        "auto_generate_contexts",
-                        "stores_base_path",
-                        "context_search_paths",
-                        "default_context",
-                        "runtime_config",
-                    }
-                ),
+                data,
                 f,
             )
 

src/kiara/context/runtime_config.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 from enum import Enum
+from typing import Literal
 
 from pydantic import Field
 from pydantic_settings import BaseSettings, SettingsConfigDict
@@ -32,6 +33,11 @@ class KiaraRuntimeConfig(BaseSettings):
     lock_context: bool = Field(
         description="Whether to lock context(s) on creation.", default=False
     )
+    runtime_profile: Literal["default", "dharpa"] = Field(
+        description="The runtime profile to use, this determines for example whether comments need to be provided when running a job.",
+        default="dharpa",
+    )
+
     # ignore_errors: bool = Field(
     #     description="If set, kiara will try to ignore most errors (that can be ignored).",
     #     default=False,

src/kiara/interfaces/__init__.py

@@ -334,6 +334,8 @@ def kiara_config(self) -> "KiaraConfig":
         else:
             kiara_config = KiaraConfig.load_from_file(config_file_path)
 
+        kiara_config.runtime_config.runtime_profile = "default"
+
         self._kiara_config = kiara_config
         return self._kiara_config
 

src/kiara/interfaces/cli/__init__.py

@@ -14,9 +14,6 @@
 import rich_click as click
 import structlog
 
-from kiara.defaults import (
-    SYMLINK_ISSUE_MSG,
-)
 from kiara.interfaces import KiaraAPIWrap
 from kiara.utils import is_debug, log_message
 from kiara.utils.class_loading import find_all_cli_subcommands
@@ -95,15 +92,14 @@ def cli(
     For more information, visit the [i][b]kiara[/b] homepage[/i]: https://dharpa.org/kiara.documentation .
     """
     # check if windows symlink work
-    from kiara.utils.windows import check_symlink_works
-
-    if not check_symlink_works():
-
-        terminal_print()
-        from rich.markdown import Markdown
 
-        terminal_print(Markdown(SYMLINK_ISSUE_MSG))
-        sys.exit(1)
+    # if not check_symlink_works():
+    #
+    #     terminal_print()
+    #     from rich.markdown import Markdown
+    #
+    #     terminal_print(Markdown(SYMLINK_ISSUE_MSG))
+    #     sys.exit(1)
 
     context_subcommand = ctx.invoked_subcommand == "context"
     if context_subcommand and use_background_service:

src/kiara/interfaces/cli/run.py

@@ -44,6 +44,9 @@
 @click.option(
     "--output", "-o", help="The output format and configuration.", multiple=True
 )
+@click.option(
+    "--comment", "-c", help="Add comment metadata to the job you run.", required=False
+)
 @click.option(
     "--save",
     "-s",
@@ -67,6 +70,7 @@ def run(
     module_config: Iterable[str],
     inputs: Iterable[str],
     output: Iterable[str],
+    comment: Union[str, None],
     explain: bool,
     save: Iterable[str],
     print_properties: bool,
@@ -249,6 +253,7 @@ def run(
             api=api,
             operation=kiara_op,
             inputs=inputs_value_map,
+            comment=comment,
             silent=silent,
             save_results=bool(final_aliases),
             aliases=final_aliases,