fix(switch_repo): honor use_python_binary when recreating venv (#793)

* fix(switch_repo): honor use_python_binary when recreating venv

* fix(switch_repo): validate name at function entry

.gitignore

@@ -7,6 +7,7 @@
 *.tmp
 __pycache__
 .kiauh-env
+.venv
 *.code-workspace
 *.iml
 kiauh.cfg

AGENTS.md

@@ -0,0 +1,68 @@
+# AGENTS.md - KIAUH Development Guide
+
+## Project Overview
+
+KIAUH (Klipper Installation And Update Helper) is a Python-based installation script for Klipper 3D printer firmware and related components written in Python 3.8+.
+
+## Running KIAUH
+
+```bash
+./kiauh.sh
+```
+
+**Important:** Must NOT run as root. The script will exit if EUID is 0.
+
+## Development Commands
+
+```bash
+# Install dev dependencies
+pip install -r requirements-dev.txt
+
+# Lint (ruff)
+ruff check .
+
+# Format
+ruff format .
+
+# Typecheck
+mypy kiauh
+
+# Run tests
+pytest
+
+# Run specific test file
+pytest kiauh/core/simple_config_parser/tests/public_api/test_options_api.py
+```
+
+## Testing
+
+- New tests should be placed near their corresponding components/modules (e.g., `kiauh/components/klipper/*/test_*.py`)
+- Always use a `tests/` subdirectory
+- Existing pytest setup in `kiauh/core/simple_config_parser/tests/` serves as reference
+
+## Project Structure
+
+- `kiauh.sh` - Bash entry point, sets PYTHONPATH and calls main.py
+- `kiauh/main.py` - Python entry point
+- `kiauh/core/` - Core functionality (menus, services, settings, types)
+- `kiauh/components/` - Klipper components (klipper, moonraker, webui_client, etc.)
+- `kiauh/extensions/` - Extension system for optional addons (obico, octoprint, spoolman, etc.)
+- `kiauh/core/simple_config_parser/` - Custom INI-style config parser for Klipper configs
+- `kiauh/core/simple_config_parser/src/simple_config_parser/` - Submodule (git subtree)
+
+## Key Quirks
+
+1. **Python version:** Requires Python 3.8+ (checked in kiauh.sh)
+2. **Config files:** KIAUH uses `kiauh.cfg` in project root (not .ini format - it's parsed by simple_config_parser)
+3. **Submodule:** `kiauh/core/simple_config_parser/` is a git subtree, not a submodule
+4. **Branch check:** KIAUH only checks for updates on master branch (not develop)
+5. **Target:** Designed to run on Raspberry Pi OS / Debian-based distros
+
+## Code Style
+
+- 4-space indentation
+- 88 character line length
+- Double quotes
+- LF line endings
+- Type hints required (mypy checks)
+- Ruff with I (isort) enabled

kiauh.sh

@@ -15,18 +15,30 @@ clear -x
 # make sure we have the correct permissions while running the script
 umask 022
 
+# gets the path where this script is located
+KIAUH_SRCDIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd)
+
+# colors
+white="\033[37m"
+cyan="\033[96m"
+red="\033[91m"
+yellow="\033[93m"
+green="\033[92m"
+
 #===================================================#
 #=================== UPDATE KIAUH ==================#
 #===================================================#
 
 function update_kiauh() {
-  status_msg "Updating KIAUH ..."
+  echo "Updating KIAUH ..."
 
   cd "${KIAUH_SRCDIR}"
   git reset --hard && git pull
 
-  ok_msg "Update complete! Please restart KIAUH."
+  echo "Update complete! Restarting..."
-  exit 0
+  sleep 1
+  exec "$0" "$@" # restarts the script
+
 }
 
 #===================================================#
@@ -65,16 +77,18 @@ function kiauh_update_dialog() {
   echo -e "\-------------------------------------------------------/"
 
   local yn
-  read -p "${cyan}###### Do you want to update now? (Y/n):${white} " yn
+  echo -ne "${cyan}###### Do you want to update now? (Y/n):${white} "
+  read yn
   while true; do
     case "${yn}" in
      Y|y|Yes|yes|"")
-       do_action "update_kiauh"
+       update_kiauh
        break;;
      N|n|No|no)
        break;;
      *)
-       deny_action "kiauh_update_dialog";;
+       echo -e "${red}Invalid input. Please try again.${white}"
+       kiauh_update_dialog;;
     esac
   done
 }

kiauh/components/crowsnest/crowsnest.py

@@ -47,7 +47,7 @@ from utils.sys_utils import (
 
 def install_crowsnest() -> None:
     # Step 1: Clone crowsnest repo
-    git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR, "master")
+    git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR)
 
     # Step 2: Install dependencies
     check_install_dependencies({"make"})

kiauh/components/klipper/klipper_utils.py

@@ -34,7 +34,7 @@ from core.constants import CURRENT_USER
 from core.instance_manager.base_instance import SUFFIX_BLACKLIST
 from core.logger import DialogType, Logger
 from core.services.backup_service import BackupService
-from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+from core.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
 from core.types.component_status import ComponentStatus
@@ -113,7 +113,7 @@ def check_user_groups() -> None:
 
     if not get_confirm(f"Add user '{CURRENT_USER}' to group(s) now?"):
         log = "Skipped adding user to required groups. You might encounter issues."
-        Logger.warn(log)
+        Logger.print_warn(log)
         return
 
     try:

kiauh/components/klipper_firmware/menus/klipper_flash_menu.py

@@ -236,9 +236,11 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
         if len(self.flash_options.mcu_list) < 1:
             Logger.print_warn("No MCUs found!")
             Logger.print_warn("Make sure they are connected and repeat this step.")
+            time.sleep(3)
+            return
 
         # if standalone is True, we only display the MCUs to the user and return
-        if self.__standalone and len(self.flash_options.mcu_list) > 0:
+        if self.__standalone:
             Logger.print_ok("The following MCUs were found:", prefix=False)
             for i, mcu in enumerate(self.flash_options.mcu_list):
                 print(f"   ● MCU #{i}: {Color.CYAN}{mcu}{Color.RST}")

kiauh/components/moonraker/moonraker.py

@@ -25,7 +25,7 @@ from components.moonraker import (
 from core.constants import CURRENT_USER
 from core.instance_manager.base_instance import BaseInstance
 from core.logger import Logger
-from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+from core.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
 from utils.fs_utils import create_folders

kiauh/components/moonraker/utils/utils.py

@@ -25,7 +25,7 @@ from components.moonraker.utils.sysdeps_parser import SysDepsParser
 from components.webui_client.base_data import BaseWebClient
 from core.logger import Logger
 from core.services.backup_service import BackupService
-from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+from core.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
 from core.types.component_status import ComponentStatus

kiauh/components/webui_client/client_config/client_config_remove.py

@@ -8,7 +8,7 @@
 # ======================================================================= #
 
 
-from typing import List
+from typing import List, Optional
 
 from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
@@ -27,6 +27,7 @@ def run_client_config_removal(
     client_config: BaseWebClientConfig,
     kl_instances: List[Klipper],
     mr_instances: List[Moonraker],
+    svc: Optional[BackupService] = None,
 ) -> Message:
     completion_msg = Message(
         title=f"{client_config.display_name} Removal Process completed",
@@ -36,12 +37,15 @@ def run_client_config_removal(
     if run_remove_routines(client_config.config_dir):
         completion_msg.text.append(f"● {client_config.display_name} removed")
 
-    BackupService().backup_printer_config_dir()
+    if svc is None:
+        svc = BackupService()
 
+    svc.backup_moonraker_conf()
     completion_msg = remove_moonraker_config_section(
         completion_msg, client_config, mr_instances
     )
 
+    svc.backup_printer_cfg()
     completion_msg = remove_printer_config_section(
         completion_msg, client_config, kl_instances
     )

kiauh/components/webui_client/client_remove.py

@@ -41,6 +41,7 @@ def run_client_removal(
     )
     mr_instances: List[Moonraker] = get_instances(Moonraker)
     kl_instances: List[Klipper] = get_instances(Klipper)
+    svc = BackupService()
 
     if backup_config:
         version = ""
@@ -49,7 +50,6 @@ def run_client_removal(
             with open(src.joinpath(".version"), "r") as v:
                 version = v.readlines()[0]
 
-        svc = BackupService()
         target_path = svc.backup_root.joinpath(f"{client.client_dir.name}_{version}")
         success = svc.backup_file(
             source_path=client.config_file,
@@ -67,7 +67,7 @@ def run_client_removal(
         if remove_client_nginx_logs(client, kl_instances):
             completion_msg.text.append("● NGINX logs removed")
 
-        BackupService().backup_moonraker_conf()
+        svc.backup_moonraker_conf()
         section = f"update_manager {client_name}"
         handled_instances: List[Moonraker] = remove_config_section(
             section, mr_instances
@@ -83,6 +83,7 @@ def run_client_removal(
             client.client_config,
             kl_instances,
             mr_instances,
+            svc,
         )
         if cfg_completion_msg.color == Color.GREEN:
             completion_msg.text.extend(cfg_completion_msg.text[1:])

kiauh/components/webui_client/client_utils.py

@@ -33,7 +33,7 @@ from core.constants import (
 from core.logger import Logger
 from core.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings, WebUiSettings
-from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+from core.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
 from core.types.color import Color
@@ -78,10 +78,10 @@ def get_current_client_config() -> str:
     installed = [c for c in clients if c.client_config.config_dir.exists()]
 
     if not installed:
-        return Color.apply("-", Color.CYAN)
+        return str(Color.apply("-", Color.CYAN))
     elif len(installed) == 1:
         cfg = installed[0].client_config
-        return Color.apply(cfg.display_name, Color.CYAN)
+        return str(Color.apply(cfg.display_name, Color.CYAN))
 
     # at this point, both client config folders exists, so we need to check
     # which are actually included in the printer.cfg of all klipper instances
@@ -100,18 +100,18 @@ def get_current_client_config() -> str:
 
         # if both are included in the same file, we have a potential conflict
         if includes_mainsail and includes_fluidd:
-            return Color.apply("Conflict", Color.YELLOW)
+            return str(Color.apply("Conflict", Color.YELLOW))
 
     if not mainsail_includes and not fluidd_includes:
         # there are no includes at all, even though the client config folders exist
-        return Color.apply("-", Color.CYAN)
+        return str(Color.apply("-", Color.CYAN))
     elif len(fluidd_includes) > len(mainsail_includes):
         # there are more instances that include fluidd than mainsail
-        return Color.apply(fluidd.client_config.display_name, Color.CYAN)
+        return str(Color.apply(fluidd.client_config.display_name, Color.CYAN))
     else:
         # there are the same amount of non-conflicting includes for each config
         # or more instances include mainsail than fluidd
-        return Color.apply(mainsail.client_config.display_name, Color.CYAN)
+        return str(Color.apply(mainsail.client_config.display_name, Color.CYAN))
 
 
 def enable_mainsail_remotemode() -> None:
@@ -152,10 +152,9 @@ def symlink_webui_nginx_log(
 def get_local_client_version(client: BaseWebClient) -> str | None:
     relinfo_file = client.client_dir.joinpath("release_info.json")
     version_file = client.client_dir.joinpath(".version")
-    default = "n/a"
 
     if not client.client_dir.exists():
-        return default
+        return None
 
     # try to get version from release_info.json first
     if relinfo_file.is_file():
@@ -177,11 +176,11 @@ def get_local_client_version(client: BaseWebClient) -> str | None:
         try:
             with open(version_file, "r") as f:
                 line = f.readline().strip()
-            return line or default
+            return line or None
         except OSError:
             Logger.print_error("Unable to read '.version'")
 
-    return default
+    return None
 
 
 def get_remote_client_version(client: BaseWebClient) -> str | None:
@@ -446,9 +445,9 @@ def get_client_port_selection(
     while True:
         _type = "Reconfigure" if reconfigure else "Configure"
         question = f"{_type} {client.display_name} for port"
-        port_input = get_number_input(question, min_value=80, default=port)
+        port_input: int | None = get_number_input(question, min_value=80, default=port)
 
-        if port_input not in ports_in_use:
+        if port_input and port_input not in ports_in_use:
             client_settings: WebUiSettings = settings[client.name]
             client_settings.port = port_input
             settings.save()

kiauh/components/webui_client/menus/client_install_menu.py

@@ -97,7 +97,7 @@ class ClientInstallMenu(BaseMenu):
         self.message_service.set_message(message)
 
     def _get_current_port(self) -> int:
-        curr_port = get_nginx_listen_port(self.client.nginx_config)
+        curr_port: int | None = get_nginx_listen_port(self.client.nginx_config)
         if curr_port is None:
             # if the port is not found in the config file we use
             # the default port from the kiauh settings as fallback

kiauh/core/menus/main_menu.py

@@ -95,8 +95,8 @@ class MainMenu(BaseMenu):
         status_data: ComponentStatus = status_fn(*args)
         code: int = status_data.status
         status: StatusText = StatusMap[code]
-        owner: str = trunc_string(status_data.owner, 23)
+        owner: str = trunc_string(status_data.owner, 23) if status_data.owner else '-'
-        repo: str = trunc_string(status_data.repo, 23)
+        repo: str = trunc_string(status_data.repo, 23) if status_data.repo else '-'
         instance_count: int = status_data.instances
 
         count_txt: str = ""

kiauh/core/menus/settings_menu.py

@@ -100,11 +100,11 @@ class SettingsMenu(BaseMenu):
         def trim_repo_url(repo: str) -> str:
             return repo.replace(".git", "").replace("https://", "").replace("git@", "")
 
-        if not klipper_status.repo == "-":
+        if klipper_status.repo:
             url = trim_repo_url(klipper_status.repo_url)
             self.kl_repo_url = Color.apply(url, Color.CYAN)
             self.kl_branch = Color.apply(klipper_status.branch, Color.CYAN)
-        if not moonraker_status.repo == "-":
+        if moonraker_status.repo:
             url = trim_repo_url(moonraker_status.repo_url)
             self.mr_repo_url = Color.apply(url, Color.CYAN)
             self.mr_branch = Color.apply(moonraker_status.branch, Color.CYAN)

kiauh/core/menus/update_menu.py

@@ -251,20 +251,23 @@ class UpdateMenu(BaseMenu):
         self._set_status_data("klipperscreen", get_klipperscreen_status)
         self._set_status_data("crowsnest", get_crowsnest_status)
 
+        self._fetch_system_package_update_status()
+
+    def _fetch_system_package_update_status(self) -> None:
         update_system_package_lists(silent=True)
         self.packages = get_upgradable_packages()
         self.package_count = len(self.packages)
 
     def _format_local_status(self, local_version, remote_version) -> str:
         color = Color.RED
-        if not local_version:
+        if local_version is None:
             color = Color.RED
         elif local_version == remote_version:
             color = Color.GREEN
         elif local_version != remote_version:
             color = Color.YELLOW
 
-        return Color.apply(local_version or "-", color)
+        return str(Color.apply(local_version or '-', color))
 
     def _set_status_data(self, name: str, status_fn: Callable, *args) -> None:
         comp_status: ComponentStatus = status_fn(*args)
@@ -290,7 +293,13 @@ class UpdateMenu(BaseMenu):
         return self.status_data[name]["installed"]
 
     def _is_update_available(self, name: str) -> bool:
-        return self.status_data[name]["local"] != self.status_data[name]["remote"]
+        local = self.status_data[name]["local"]
+        remote = self.status_data[name]["remote"]
+
+        if local is None or remote is None:
+            return False
+
+        return local != remote
 
     def _run_update_routine(self, name: str, update_fn: Callable, *args) -> None:
         display_name = self.status_data[name]["display_name"]
@@ -306,6 +315,27 @@ class UpdateMenu(BaseMenu):
 
         update_fn(*args)
 
+        self._refresh_component_status(name)
+
+    def _refresh_component_status(self, name: str) -> None:
+        """Refresh the status data for a component after an update."""
+        if name == "klipper":
+            self._set_status_data("klipper", get_klipper_status)
+        elif name == "moonraker":
+            self._set_status_data("moonraker", get_moonraker_status)
+        elif name == "mainsail":
+            self._set_status_data("mainsail", get_client_status, self.mainsail_data, True)
+        elif name == "mainsail_config":
+            self._set_status_data("mainsail_config", get_client_config_status, self.mainsail_data)
+        elif name == "fluidd":
+            self._set_status_data("fluidd", get_client_status, self.fluidd_data, True)
+        elif name == "fluidd_config":
+            self._set_status_data("fluidd_config", get_client_config_status, self.fluidd_data)
+        elif name == "klipperscreen":
+            self._set_status_data("klipperscreen", get_klipperscreen_status)
+        elif name == "crowsnest":
+            self._set_status_data("crowsnest", get_crowsnest_status)
+
     def _run_system_updates(self) -> None:
         if not self.packages:
             Logger.print_info("No system upgrades available!")
@@ -313,15 +343,20 @@ class UpdateMenu(BaseMenu):
 
         try:
             pkgs: str = ", ".join(self.packages)
+
             Logger.print_dialog(
                 DialogType.CUSTOM,
                 ["The following packages will be upgraded:", "\n\n", pkgs],
                 custom_title="UPGRADABLE SYSTEM UPDATES",
             )
-            if not get_confirm("Continue?"):
+
+            if not get_confirm("Upgrade packages?"):
                 return
+
             Logger.print_status("Upgrading system packages ...")
+
             upgrade_system_packages(self.packages)
+            self._fetch_system_package_update_status()
         except Exception as e:
             Logger.print_error(f"Error upgrading system packages:\n{e}")
             raise

kiauh/core/services/backup_service.py

@@ -22,6 +22,7 @@ from utils.instance_utils import get_instances
 class BackupService:
     def __init__(self):
         self._backup_root = Path.home().joinpath("kiauh_backups")
+        self._timestamp = datetime.now().strftime("%Y%m%d-%H%M%S")
 
     @property
     def backup_root(self) -> Path:
@@ -29,7 +30,7 @@ class BackupService:
 
     @property
     def timestamp(self) -> str:
-        return datetime.now().strftime("%Y%m%d-%H%M%S")
+        return self._timestamp
 
     ################################################
     # GENERIC BACKUP METHODS
@@ -68,10 +69,15 @@ class BackupService:
                 backup_dir = self._backup_root.joinpath(target_path)
 
             backup_dir.mkdir(parents=True, exist_ok=True)
-            shutil.copy2(source_path, backup_dir.joinpath(filename))
+            target_path = backup_dir.joinpath(filename)
+            if target_path.exists():
+                Logger.print_info(f"File '{target_path}' already exists. Skipping ...")
+                return True
+
+            shutil.copy2(source_path, target_path)
 
             Logger.print_ok(
-                f"Successfully backed up '{source_path}' to '{backup_dir}'"
+                f"Successfully backed up '{source_path}' to '{target_path}'"
             )
             return True
 
@@ -111,7 +117,18 @@ class BackupService:
 
             if backup_path.exists():
                 Logger.print_info(f"Reusing existing backup directory '{backup_path}'")
-
+                for item in source_path.rglob("*"):
+                    relative_path = item.relative_to(source_path)
+                    target_item = backup_path.joinpath(relative_path)
+                    if item.is_file():
+                        if not target_item.exists():
+                            target_item.parent.mkdir(parents=True, exist_ok=True)
+                            shutil.copy2(item, target_item)
+                        else:
+                            Logger.print_info(f"File '{target_item}' already exists. Skipping...")
+                    elif item.is_dir():
+                        target_item.mkdir(parents=True, exist_ok=True)
+            else:
                 shutil.copytree(
                     source_path,
                     backup_path,
@@ -134,27 +151,29 @@ class BackupService:
     ################################################
 
     def backup_printer_cfg(self):
+        """Backup printer.cfg files of all Klipper instances.
+        Files are backed up to:
+        {backup_root}/{instance_data_dir_name}/printer_{timestamp}.cfg
+        """
         klipper_instances: List[Klipper] = get_instances(Klipper)
         for instance in klipper_instances:
-            target_path: Path = self._backup_root.joinpath(
+            target_path: Path = self._backup_root.joinpath(instance.data_dir.name)
-                instance.data_dir.name, f"config_{self.timestamp}"
-            )
             self.backup_file(
                 source_path=instance.cfg_file,
                 target_path=target_path,
-                target_name=instance.cfg_file.name,
             )
 
     def backup_moonraker_conf(self):
+        """Backup moonraker.conf files of all Moonraker instances.
+        Files are backed up to:
+        {backup_root}/{instance_data_dir_name}/moonraker_{timestamp}.conf
+        """
         moonraker_instances: List[Moonraker] = get_instances(Moonraker)
         for instance in moonraker_instances:
-            target_path: Path = self._backup_root.joinpath(
+            target_path: Path = self._backup_root.joinpath(instance.data_dir.name)
-                instance.data_dir.name, f"config_{self.timestamp}"
-            )
             self.backup_file(
                 source_path=instance.cfg_file,
                 target_path=target_path,
-                target_name=instance.cfg_file.name,
             )
 
     def backup_printer_config_dir(self) -> None:

kiauh/core/settings/kiauh_settings.py

@@ -16,7 +16,7 @@ from components.klipper import KLIPPER_REPO_URL
 from components.moonraker import MOONRAKER_REPO_URL
 from core.logger import DialogType, Logger
 from core.services.backup_service import BackupService
-from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+from core.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
 from utils.input_utils import get_confirm

kiauh/core/simple_config_parser/tests/line_matching/match_empty_line/test_match_empty_line.py

@@ -10,8 +10,8 @@ from pathlib import Path
 
 import pytest
 
-from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from core.simple_config_parser.simple_config_parser import SimpleConfigParser
-from tests.utils import load_testdata_from_file
+from core.simple_config_parser.tests.utils import load_testdata_from_file
 
 BASE_DIR = Path(__file__).parent.joinpath("test_data")
 MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")

kiauh/core/simple_config_parser/tests/line_matching/match_gcode_block_start/test_match_gcode_block_start.py

@@ -10,8 +10,8 @@ from pathlib import Path
 
 import pytest
 
-from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from core.simple_config_parser.simple_config_parser import SimpleConfigParser
-from tests.utils import load_testdata_from_file
+from core.simple_config_parser.tests.utils import load_testdata_from_file
 
 BASE_DIR = Path(__file__).parent.joinpath("test_data")
 MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")

kiauh/core/simple_config_parser/tests/line_matching/match_line_comment/test_match_line_comment.py

@@ -10,8 +10,8 @@ from pathlib import Path
 
 import pytest
 
-from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from core.simple_config_parser.simple_config_parser import SimpleConfigParser
-from tests.utils import load_testdata_from_file
+from core.simple_config_parser.tests.utils import load_testdata_from_file
 
 BASE_DIR = Path(__file__).parent.joinpath("test_data")
 MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")

kiauh/core/simple_config_parser/tests/line_matching/match_option/test_match_option.py

@@ -10,8 +10,8 @@ from pathlib import Path
 
 import pytest
 
-from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from core.simple_config_parser.simple_config_parser import SimpleConfigParser
-from tests.utils import load_testdata_from_file
+from core.simple_config_parser.tests.utils import load_testdata_from_file
 
 BASE_DIR = Path(__file__).parent.joinpath("test_data")
 MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")

kiauh/core/simple_config_parser/tests/line_matching/match_option_block_start/test_match_options_block_start.py

@@ -10,8 +10,8 @@ from pathlib import Path
 
 import pytest
 
-from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from core.simple_config_parser.simple_config_parser import SimpleConfigParser
-from tests.utils import load_testdata_from_file
+from core.simple_config_parser.tests.utils import load_testdata_from_file
 
 BASE_DIR = Path(__file__).parent.joinpath("test_data")
 MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")

kiauh/core/simple_config_parser/tests/line_matching/match_save_config_content/test_match_save_config_content.py

@@ -10,8 +10,8 @@ from pathlib import Path
 
 import pytest
 
-from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from core.simple_config_parser.simple_config_parser import SimpleConfigParser
-from tests.utils import load_testdata_from_file
+from core.simple_config_parser.tests.utils import load_testdata_from_file
 
 BASE_DIR = Path(__file__).parent.joinpath("test_data")
 MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")

kiauh/core/simple_config_parser/tests/line_matching/match_save_config_start/test_match_save_config_start.py

@@ -10,8 +10,8 @@ from pathlib import Path
 
 import pytest
 
-from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from core.simple_config_parser.simple_config_parser import SimpleConfigParser
-from tests.utils import load_testdata_from_file
+from core.simple_config_parser.tests.utils import load_testdata_from_file
 
 BASE_DIR = Path(__file__).parent.joinpath("test_data")
 MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")

kiauh/core/simple_config_parser/tests/line_matching/match_section/test_match_section.py

@@ -10,8 +10,8 @@ from pathlib import Path
 
 import pytest
 
-from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from core.simple_config_parser.simple_config_parser import SimpleConfigParser
-from tests.utils import load_testdata_from_file
+from core.simple_config_parser.tests.utils import load_testdata_from_file
 
 BASE_DIR = Path(__file__).parent.joinpath("test_data")
 MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")

kiauh/core/simple_config_parser/tests/line_parsing/test_line_parsing.py

@@ -10,7 +10,7 @@ from typing import List
 
 import pytest
 
-from src.simple_config_parser.simple_config_parser import (
+from core.simple_config_parser.simple_config_parser import (
     BlankLine,
     CommentLine,
     MLOptionValue,

kiauh/core/simple_config_parser/tests/line_parsing/test_multiline_update_behavior.py

@@ -3,7 +3,7 @@
 # ======================================================================= #
 from pathlib import Path
 
-from src.simple_config_parser.simple_config_parser import (
+from core.simple_config_parser.simple_config_parser import (
     BlankLine,
     MultiLineOption,
     SimpleConfigParser,

kiauh/core/simple_config_parser/tests/public_api/conftest.py

@@ -9,7 +9,7 @@ from pathlib import Path
 
 import pytest
 
-from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from core.simple_config_parser.simple_config_parser import SimpleConfigParser
 
 BASE_DIR = Path(__file__).parent.parent.joinpath("assets")
 CONFIG_FILES = [

kiauh/core/simple_config_parser/tests/public_api/test_gcode_block.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from src.simple_config_parser.simple_config_parser import Gcode, SimpleConfigParser
+from core.simple_config_parser.simple_config_parser import Gcode, SimpleConfigParser
 
 ASSETS = Path(__file__).parent.parent / "assets"
 GCODE_FILE = ASSETS / "test_gcode.cfg"

kiauh/core/simple_config_parser/tests/public_api/test_options_api.py

@@ -8,7 +8,7 @@
 
 import pytest
 
-from src.simple_config_parser.simple_config_parser import (
+from core.simple_config_parser.simple_config_parser import (
     MultiLineOption,
     NoOptionError,
     NoSectionError,

kiauh/core/simple_config_parser/tests/public_api/test_read_file.py

@@ -7,7 +7,7 @@
 # ======================================================================= #
 from pathlib import Path
 
-from src.simple_config_parser.simple_config_parser import Section, SimpleConfigParser
+from core.simple_config_parser.simple_config_parser import Section, SimpleConfigParser
 
 BASE_DIR = Path(__file__).parent.parent / "assets"
 TEST_DATA_PATH = BASE_DIR / "test_config_1.cfg"

kiauh/core/simple_config_parser/tests/public_api/test_sections_api.py

@@ -8,7 +8,7 @@
 
 import pytest
 
-from src.simple_config_parser.simple_config_parser import (
+from core.simple_config_parser.simple_config_parser import (
     DuplicateSectionError,
 )
 

kiauh/core/simple_config_parser/tests/public_api/test_write_file.py

@@ -9,7 +9,7 @@ from pathlib import Path
 
 import pytest
 
-from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from core.simple_config_parser.simple_config_parser import SimpleConfigParser
 
 BASE_DIR = Path(__file__).parent.parent / "assets"
 TEST_DATA_PATH = BASE_DIR / "test_config_1.cfg"

kiauh/core/simple_config_parser/tests/value_conversion/test_get_conv.py

@@ -9,7 +9,7 @@ from pathlib import Path
 
 import pytest
 
-from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from core.simple_config_parser.simple_config_parser import SimpleConfigParser
 
 BASE_DIR = Path(__file__).parent.parent / "assets"
 TEST_DATA_PATH = BASE_DIR / "test_config_1.cfg"

kiauh/core/submodules/simple_config_parser/.editorconfig

@@ -1,13 +0,0 @@
-# see https://editorconfig.org/
-root = true
-
-[*]
-end_of_line = lf
-trim_trailing_whitespace = true
-indent_style = space
-insert_final_newline = true
-indent_size = 4
-charset = utf-8
-
-[*.py]
-max_line_length = 88

kiauh/core/submodules/simple_config_parser/.gitignore

@@ -1,13 +0,0 @@
-*.py[cod]
-*.pyc
-__pycache__
-.pytest_cache/
-
-.idea/
-.vscode/
-
-.venv*/
-venv*/
-
-.coverage
-htmlcov/

kiauh/core/submodules/simple_config_parser/LICENSE

@@ -1,674 +0,0 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<https://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.

kiauh/core/submodules/simple_config_parser/pyproject.toml

@@ -1,66 +0,0 @@
-[project]
-name = "simple-config-parser"
-version = "0.0.1"
-description = "A simple config parser for Python"
-authors = [
-    {name = "Dominik Willner", email = "th33xitus@gmail.com"},
-]
-readme = "README.md"
-license = {text = "GPL-3.0-only"}
-requires-python = ">=3.8"
-
-[project.urls]
-homepage = "https://github.com/dw-0/simple-config-parser"
-repository = "https://github.com/dw-0/simple-config-parser"
-documentation = "https://github.com/dw-0/simple-config-parser"
-
-[project.optional-dependencies]
-dev=["ruff"]
-
-[tool.ruff]
-required-version = ">=0.3.4"
-respect-gitignore = true
-exclude = [".git",".github", "./docs"]
-line-length = 88
-indent-width = 4
-output-format = "full"
-
-[tool.ruff.format]
-indent-style = "space"
-line-ending = "lf"
-quote-style = "double"
-
-[tool.ruff.lint]
-extend-select = ["I"]
-
-[tool.pytest.ini_options]
-minversion = "8.2.1"
-testpaths = ["tests/**/*.py"]
-addopts = "-svvv --cov --cov-config=pyproject.toml --cov-report=html"
-
-[tool.coverage.run]
-branch = true
-source = ["src.simple_config_parser"]
-
-[tool.coverage.report]
-# Regexes for lines to exclude from consideration
-exclude_also = [
-    # Don't complain about missing debug-only code:
-    "def __repr__",
-    "if self\\.debug",
-
-    # Don't complain if tests don't hit defensive assertion code:
-    "raise AssertionError",
-    "raise NotImplementedError",
-
-    # Don't complain if non-runnable code isn't run:
-    "if 0:",
-    "if __name__ == .__main__.:",
-
-    # Don't complain about abstract methods, they aren't run:
-    "@(abc\\.)?abstractmethod",
-    ]
-
-[tool.coverage.html]
-title = "SimpleConfigParser Coverage Report"
-directory = "htmlcov"

kiauh/core/submodules/simple_config_parser/requirements-dev.txt

@@ -1,3 +0,0 @@
-ruff >= 0.3.4
-pytest >= 8.2.1
-pytest-cov >= 5.0.0

kiauh/core/types/component_status.py

@@ -26,7 +26,7 @@ class ComponentStatus:
     owner: str | None = None
     repo: str | None = None
     repo_url: str | None = None
-    branch: str = ""
+    branch: str | None = None
     local: str | None = None
     remote: str | None = None
     instances: int | None = None

kiauh/extensions/__init__.py

@@ -10,3 +10,4 @@
 from pathlib import Path
 
 EXTENSION_ROOT = Path(__file__).resolve().parents[1].joinpath("extensions")
+GITHUB_ISSUES_URL = "https://github.com/dw-0/kiauh/issues"

kiauh/extensions/extensions_menu.py

@@ -19,7 +19,7 @@ from core.logger import Logger
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
 from core.types.color import Color
-from extensions import EXTENSION_ROOT
+from extensions import EXTENSION_ROOT, GITHUB_ISSUES_URL
 from extensions.base_extension import BaseExtension
 
 
@@ -56,6 +56,22 @@ class ExtensionsMenu(BaseMenu):
                 with open(metadata_json, "r") as m:
                     # read extension metadata from json
                     metadata = json.load(m).get("metadata")
+                    index = str(metadata.get("index"))
+
+                    # Prevent collisions where one extension silently overrides another.
+                    if index in ext_dict:
+                        existing_name = ext_dict[index].metadata.get("display_name")
+                        duplicate_name = metadata.get("display_name")
+                        Logger.print_warn(
+                            "Failed loading extension"
+                            f" {ext}: duplicate index '{index}'"
+                            f" already used by '{existing_name}'."
+                            f" Skipping '{duplicate_name}'."
+                            f" Please report this at {GITHUB_ISSUES_URL}."
+                        )
+                        continue
+
+                    int(index)
                     module_name = metadata.get("module")
                     module_path = f"kiauh.extensions.{ext.name}.{module_name}"
 
@@ -73,10 +89,20 @@ class ExtensionsMenu(BaseMenu):
 
                     # instantiate the extension with its metadata and add to dict
                     ext_instance: BaseExtension = ext_class(metadata)
-                    ext_dict[f"{metadata.get('index')}"] = ext_instance
+                    ext_dict[index] = ext_instance
 
-            except (IOError, json.JSONDecodeError, ImportError) as e:
+            except (
-                print(f"Failed loading extension {ext}: {e}")
+                IOError,
+                json.JSONDecodeError,
+                ImportError,
+                TypeError,
+                ValueError,
+                AttributeError,
+            ) as e:
+                Logger.print_warn(
+                    f"Failed loading extension {ext}: {e}. "
+                    f"Please report this at {GITHUB_ISSUES_URL}."
+                )
 
         return dict(sorted(ext_dict.items(), key=lambda x: int(x[0])))
 

kiauh/extensions/gcode_shell_cmd/gcode_shell_cmd_extension.py

@@ -16,7 +16,7 @@ from components.klipper.klipper import Klipper
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import Logger
 from core.services.backup_service import BackupService
-from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+from core.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
 from extensions.base_extension import BaseExtension
@@ -97,7 +97,7 @@ class GcodeShellCmdExtension(BaseExtension):
 
     def install_example_cfg(self, instances: List[Klipper]):
         cfg_dirs = [instance.base.cfg_dir for instance in instances]
-        # copy extension to klippy/extras
+        # copy extension to config directories
         for cfg_dir in cfg_dirs:
             Logger.print_status(f"Create shell_command.cfg in '{cfg_dir}' ...")
             if check_file_exist(cfg_dir.joinpath("shell_command.cfg")):

kiauh/extensions/klipper_adaptive_meshing_purging/__init__.py

@@ -0,0 +1,21 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2026 Théo Gaillard <theo.gayar@gmail.com>                #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from pathlib import Path
+
+# repo
+KAMP_REPO = "https://github.com/kyleisah/Klipper-Adaptive-Meshing-Purging"
+
+# directories
+MODULE_PATH = Path(__file__).resolve().parent
+KAMP_DIR = Path.home().joinpath("Klipper-Adaptive-Meshing-Purging")
+KLIPPER_DIR = Path.home().joinpath("klipper")
+
+# names
+KAMP_MOONRAKER_UPDATER_NAME = "update_manager Klipper-Adaptive-Meshing-Purging"

kiauh/extensions/klipper_adaptive_meshing_purging/klipper_adaptive_meshing_purging_extension.py

@@ -0,0 +1,357 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2026 Théo Gaillard <theo.gayar@gmail.com>                #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  It integrates Klipper Adaptive Meshing & Purging (KAMP):               #
+#  https://github.com/kyleisah/Klipper-Adaptive-Meshing-Purging           #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import shutil
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.services.backup_service import BackupService
+from core.simple_config_parser.simple_config_parser import (
+    SimpleConfigParser,
+)
+from extensions.base_extension import BaseExtension
+from extensions.klipper_adaptive_meshing_purging import (
+    KAMP_DIR,
+    KAMP_MOONRAKER_UPDATER_NAME,
+    KAMP_REPO,
+    KLIPPER_DIR,
+)
+from utils.config_utils import add_config_section, remove_config_section
+from utils.fs_utils import check_file_exist, create_symlink, run_remove_routines
+from utils.git_utils import git_clone_wrapper, git_pull_wrapper
+from utils.input_utils import get_confirm
+from utils.instance_utils import get_instances, stop_klipper_instances_interactively
+
+
+# noinspection PyMethodMayBeStatic
+class KlipperAdaptiveMeshingPurgingExtension(BaseExtension):
+    def install_extension(self, **kwargs) -> None:
+        Logger.print_status("Installing Klipper Adaptive Meshing Purging...")
+
+        klipper_dir_exists = check_file_exist(KLIPPER_DIR)
+        if not klipper_dir_exists:
+            Logger.print_warn(
+                "No Klipper directory found! Unable to install extension."
+            )
+            return
+
+        kl_instances: List[Klipper] = get_instances(Klipper)
+
+        kamp_exists = check_file_exist(KAMP_DIR) and self._check_cfg_exists(
+            kl_instances
+        )
+
+        overwrite = True
+        if kamp_exists:
+            overwrite = get_confirm(
+                question="Extension seems to be installed already. Overwrite?",
+                default_choice=True,
+                allow_go_back=False,
+            )
+
+        if not overwrite:
+            Logger.print_warn("Installation aborted due to user request.")
+            return
+
+        add_moonraker_update_section = get_confirm(
+            question="Add Klipper Adaptive Meshing and Purging to Moonraker update manager(s)?",
+            default_choice=True,
+            allow_go_back=False,
+        )
+
+        if not stop_klipper_instances_interactively(
+            kl_instances, "installation of KAMP"
+        ):
+            return
+
+        try:
+            git_clone_wrapper(KAMP_REPO, KAMP_DIR, force=True)
+
+            self._install_cfg(kl_instances)
+
+            if add_moonraker_update_section:
+                mr_instances: List[Moonraker] = get_instances(Moonraker)
+                self._add_moonraker_update_manager_section(mr_instances)
+            else:
+                Logger.print_info(
+                    "Skipping update section creation as per user request."
+                )
+                Logger.print_warn(
+                    "Make sure to create the corresponding section in your moonraker.conf in order to have it appear in your frontend update manager!"
+                )
+
+        except Exception as e:
+            Logger.print_error(
+                f"Error during Klipper Adaptive Meshing and Purging installation:\n{e}"
+            )
+
+            if kl_instances:
+                InstanceManager.start_all(kl_instances)
+            return
+
+        if kl_instances:
+            InstanceManager.start_all(kl_instances)
+
+        Logger.print_dialog(
+            DialogType.ATTENTION,
+            [
+                "Basic configuration files were created per instance. You must edit them to enable the extension.",
+                "Documentation:",
+                f"{KAMP_REPO}",
+                "\n\n",
+                "IMPORTANT:",
+                "1. If you'd like to use adaptive meshing, Klipper already has built-in support. Just call BED_MESH_CALIBRATE ADAPTIVE=1 in your PRINT_START macro. DO NOT USE THE FEATURE FROM THE EXTENSION",
+                "2. You MUST be thoughtful when editing values for the purge settings, as there is a risk to break parts of your printer.",
+                "3. According to KAMP's documentation, you should define 'max_extrude_cross_section' in 'printer.cfg' according to your needs.",
+            ],
+            margin_bottom=1,
+        )
+
+        Logger.print_ok("Klipper Adaptive Meshing and Purging installed successfully!")
+
+    def update_extension(self, **kwargs) -> None:
+        extension_installed = check_file_exist(KAMP_DIR)
+        if not extension_installed:
+            Logger.print_info("Extension does not seem to be installed! Skipping ...")
+            return
+
+        backup_before_update = get_confirm(
+            question="Backup Klipper Adaptive Meshing and Purging directory before update?",
+            default_choice=True,
+            allow_go_back=True,
+        )
+
+        kl_instances: List[Klipper] = get_instances(Klipper)
+
+        if not stop_klipper_instances_interactively(kl_instances, "update of KAMP"):
+            return
+
+        Logger.print_status("Updating Klipper Adaptive Meshing and Purging...")
+        try:
+            if backup_before_update:
+                Logger.print_status(
+                    "Backing up Klipper Adaptive Meshing and Purging directory ..."
+                )
+                svc = BackupService()
+                svc.backup_directory(
+                    source_path=KAMP_DIR,
+                    backup_name="Klipper-Adaptive-Meshing-Purging",
+                )
+                Logger.print_ok("Backup completed successfully.")
+
+            git_pull_wrapper(KAMP_DIR)
+
+        except Exception as e:
+            Logger.print_error(
+                f"Error during Klipper Adaptive Meshing and Purging update:\n{e}"
+            )
+
+            if kl_instances:
+                InstanceManager.start_all(kl_instances)
+                return
+
+        if kl_instances:
+            InstanceManager.start_all(kl_instances)
+
+        Logger.print_ok(
+            "Klipper Adaptive Meshing and Purging updated successfully.", end="\n\n"
+        )
+
+    def remove_extension(self, **kwargs) -> None:
+        extension_installed = check_file_exist(KAMP_DIR)
+        if not extension_installed:
+            Logger.print_info("Extension does not seem to be installed! Skipping ...")
+            return
+
+        kl_instances: List[Klipper] = get_instances(Klipper)
+
+        if not stop_klipper_instances_interactively(kl_instances, "removal of KAMP"):
+            return
+
+        try:
+            run_remove_routines(KAMP_DIR)
+            self._remove_cfg(kl_instances)
+
+            mr_instances: List[Moonraker] = get_instances(Moonraker)
+            self._remove_moonraker_update_manager_section(mr_instances)
+
+            BackupService().backup_printer_cfg()
+            remove_config_section("include KAMP_Settings.cfg", kl_instances)
+
+            Logger.print_dialog(
+                DialogType.ATTENTION,
+                [
+                    "You might want to remove [exclude_object] sections from 'printer.cfg', unless you use them for some other reason.",
+                    "\n\n",
+                    "You might also want to remove the [file_manager] sections from 'moonraker.conf', unless used otherwise.",
+                    "\n\n",
+                    "NOTE:",
+                    "'KAMP_Settings.cfg' is NOT removed automatically. ",
+                    "Please delete it manually if no longer needed.",
+                ],
+                margin_bottom=1,
+            )
+
+        except Exception as e:
+            Logger.print_error(f"Unable to remove extension:\n{e}")
+
+            if kl_instances:
+                InstanceManager.start_all(kl_instances)
+            return
+
+        if kl_instances:
+            InstanceManager.start_all(kl_instances)
+
+        Logger.print_ok("Klipper Adaptive Meshing and Purging removed successfully.")
+
+    def _install_cfg(self, kl_instances: List[Klipper]):
+        is_multi_instance = len(kl_instances) > 1
+        for instance in kl_instances:
+            cfg_dir = instance.base.cfg_dir
+            Logger.print_status(
+                f"Creating symlink for KAMP directory in '{cfg_dir}' ..."
+            )
+            create_symlink(KAMP_DIR.joinpath("Configuration"), cfg_dir.joinpath("KAMP"))
+            if is_multi_instance:
+                Logger.print_ok(f"Symlink successfully created for instance '{instance.suffix}'.")
+            else:
+                Logger.print_ok("Symlink successfully created.")
+
+            # We do not overwrite the existing config files ever
+            Logger.print_status(f"Creating KAMP_Settings.cfg in '{cfg_dir}' ...")
+            if check_file_exist(cfg_dir.joinpath("KAMP_Settings.cfg")):
+                Logger.print_info("File already exists! Skipping ...")
+                continue
+            try:
+                shutil.copy(
+                    KAMP_DIR.joinpath("Configuration/KAMP_Settings.cfg"),
+                    cfg_dir.joinpath("KAMP_Settings.cfg"),
+                )
+                if is_multi_instance:
+                    Logger.print_ok(f"Config file successfully created for instance '{instance.suffix}'.")
+                else:
+                    Logger.print_ok(f"Config file successfully created.")
+            except OSError as e:
+                Logger.print_error(f"Unable to create example config: {e}")
+
+        BackupService().backup_printer_cfg()
+
+        sections = ["include KAMP_Settings.cfg", "exclude_object"]
+        for instance in kl_instances:
+            cfg_file = instance.cfg_file
+            scp = SimpleConfigParser()
+            scp.read_file(cfg_file)
+
+            for section in sections:
+                if scp.has_section(section):
+                    continue
+                Logger.print_status(f"Add '{section}' to '{cfg_file}' ...")
+                scp.add_section(section)
+                scp.write_file(cfg_file)
+                Logger.print_ok("Done!")
+
+    def _add_moonraker_update_manager_section(
+        self, mr_instances: List[Moonraker]
+    ) -> None:
+        if not mr_instances:
+            Logger.print_dialog(
+                DialogType.WARNING,
+                [
+                    "Moonraker not found! Klipper Adaptive Meshing and Purging update "
+                    "manager support for Moonraker will not be added to moonraker.conf.",
+                ],
+            )
+            if not get_confirm(
+                "Continue Klipper Adaptive Meshing and Purging installation?",
+                default_choice=False,
+                allow_go_back=True,
+            ):
+                Logger.print_info("Installation aborted due to user request.")
+                return
+
+        BackupService().backup_moonraker_conf()
+
+        add_config_section(
+            section=KAMP_MOONRAKER_UPDATER_NAME,
+            instances=mr_instances,
+            options=[
+                ("type", "git_repo"),
+                ("channel", "dev"),
+                ("path", KAMP_DIR.as_posix()),
+                ("origin", KAMP_REPO),
+                ("managed_services", "klipper"),
+                ("primary_branch", "main"),
+            ],
+        )
+
+        add_config_section(
+            section="file_manager",
+            instances=mr_instances,
+            options=[
+                ("enable_object_processing", "True"),
+            ],
+        )
+
+        InstanceManager.restart_all(mr_instances)
+
+        Logger.print_ok(
+            "Klipper Adaptive Meshing and Purging successfully added to Moonraker update manager(s)!"
+        )
+
+    def _remove_moonraker_update_manager_section(
+        self, mr_instances: List[Moonraker]
+    ) -> None:
+        if not mr_instances:
+            Logger.print_dialog(
+                DialogType.WARNING,
+                [
+                    "Moonraker not found! Klipper Adaptive Meshing and Purging update "
+                    "manager support for Moonraker will not be removed from moonraker.conf.",
+                ],
+            )
+            return
+
+        BackupService().backup_moonraker_conf()
+
+        remove_config_section(KAMP_MOONRAKER_UPDATER_NAME, mr_instances)
+        InstanceManager.restart_all(mr_instances)
+
+        Logger.print_ok(
+            "Klipper Adaptive Meshing and Purging successfully removed from Moonraker update manager(s)!"
+        )
+
+    def _check_cfg_exists(self, kl_instances: List[Klipper]) -> bool:
+        cfg_dirs = [instance.base.cfg_dir for instance in kl_instances]
+
+        for cfg_dir in cfg_dirs:
+            if (
+                check_file_exist(cfg_dir.joinpath("KAMP_Settings.cfg"))
+                and check_file_exist(cfg_dir.joinpath("KAMP/KAMP_Settings.cfg"))
+                and check_file_exist(cfg_dir.joinpath("KAMP/Adaptive_Meshing.cfg"))
+                and check_file_exist(cfg_dir.joinpath("KAMP/Line_Purge.cfg"))
+                and check_file_exist(cfg_dir.joinpath("KAMP/Smart_Park.cfg"))
+                and check_file_exist(cfg_dir.joinpath("KAMP/Voron_Purge.cfg"))
+            ):
+                return True
+
+        return False
+
+    def _remove_cfg(self, kl_instances: List[Klipper]) -> None:
+        cfg_dirs = [instance.base.cfg_dir for instance in kl_instances]
+
+        for cfg_dir in cfg_dirs:
+            Logger.print_status(f"Removing KAMP symlink in '{cfg_dir}' ...")
+            run_remove_routines(cfg_dir.joinpath("KAMP"))

kiauh/extensions/klipper_adaptive_meshing_purging/metadata.json

@@ -0,0 +1,13 @@
+{
+  "metadata": {
+    "index": 14,
+    "module": "klipper_adaptive_meshing_purging_extension",
+    "maintained_by": "theogayar",
+    "display_name": "Klipper Adaptive Meshing Purging",
+    "description": [
+      "Klipper extension for adaptive meshing and purging."
+    ],
+    "repo": "https://github.com/kyleisah/Klipper-Adaptive-Meshing-Purging",
+    "updates": true
+  }
+}

kiauh/extensions/obico/moonraker_obico.py

@@ -16,7 +16,7 @@ from components.moonraker.moonraker import Moonraker
 from core.constants import CURRENT_USER
 from core.instance_manager.base_instance import BaseInstance
 from core.logger import Logger
-from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+from core.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
 from extensions.obico import (

kiauh/extensions/obico/moonraker_obico_extension.py

@@ -15,7 +15,7 @@ from core.instance_manager.base_instance import SUFFIX_BLACKLIST
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
 from core.services.backup_service import BackupService
-from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+from core.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
 from extensions.base_extension import BaseExtension

kiauh/extensions/simply_print/simply_print_extension.py

@@ -12,7 +12,7 @@ from components.moonraker.moonraker import Moonraker
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
 from core.services.backup_service import BackupService
-from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+from core.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
 from extensions.base_extension import BaseExtension

kiauh/extensions/tmc_autotune/__init__.py

@@ -0,0 +1,28 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from pathlib import Path
+
+# repo
+TMCA_REPO = "https://github.com/andrewmcgr/klipper_tmc_autotune"
+
+# directories
+TMCA_DIR = Path.home().joinpath("klipper_tmc_autotune")
+MODULE_PATH = Path(__file__).resolve().parent
+KLIPPER_DIR = Path.home().joinpath("klipper")
+KLIPPER_EXTRAS = KLIPPER_DIR.joinpath("klippy/extras")
+KLIPPER_PLUGINS = KLIPPER_DIR.joinpath("klippy/plugins")
+KLIPPER_EXTENSIONS_PATH = (
+    KLIPPER_PLUGINS if KLIPPER_PLUGINS.is_dir() else KLIPPER_EXTRAS
+)
+
+# files
+TMCA_EXAMPLE_CONFIG = TMCA_DIR.joinpath("docs/example.cfg")
+
+# names
+TMCA_MOONRAKER_UPDATER_NAME = "update_manager klipper_tmc_autotune"

kiauh/extensions/tmc_autotune/metadata.json

@@ -0,0 +1,13 @@
+{
+  "metadata": {
+    "index": 13,
+    "module": "tmc_autotune_extension",
+    "maintained_by": "theogayar",
+    "display_name": "Klipper TMC Autotune",
+    "description": [
+      "Klipper extension for automatic configuration and tuning of TMC drivers."
+    ],
+    "repo": "https://github.com/andrewmcgr/klipper_tmc_autotune",
+    "updates": true
+  }
+}

kiauh/extensions/tmc_autotune/tmc_autotune_extension.py

@@ -0,0 +1,347 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2026 Théo Gaillard <theo.gayar@gmail.com>                #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+import shutil
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.services.backup_service import BackupService
+from core.simple_config_parser.simple_config_parser import (
+    SimpleConfigParser,
+)
+from extensions.base_extension import BaseExtension
+from extensions.tmc_autotune import (
+    KLIPPER_DIR,
+    KLIPPER_EXTENSIONS_PATH,
+    TMCA_DIR,
+    TMCA_EXAMPLE_CONFIG,
+    TMCA_MOONRAKER_UPDATER_NAME,
+    TMCA_REPO,
+)
+from utils.config_utils import add_config_section, remove_config_section
+from utils.fs_utils import check_file_exist, create_symlink, run_remove_routines
+from utils.git_utils import git_clone_wrapper, git_pull_wrapper
+from utils.input_utils import get_confirm
+from utils.instance_utils import get_instances, stop_klipper_instances_interactively
+from utils.sys_utils import check_python_version
+
+
+# noinspection PyMethodMayBeStatic
+class TmcAutotuneExtension(BaseExtension):
+    def install_extension(self, **kwargs) -> None:
+        Logger.print_status("Installing Klipper TMC Autotune...")
+
+        # Check for Python 3.x, aligned with upstream install script
+        if not check_python_version(3, 0):
+            Logger.print_warn("Python 3.x is required. Aborting install.")
+            return
+
+        klipper_dir_exists = check_file_exist(KLIPPER_DIR)
+        if not klipper_dir_exists:
+            Logger.print_warn(
+                "No Klipper directory found! Unable to install extension."
+            )
+            return
+
+        tmca_exists = (
+            check_file_exist(TMCA_DIR)
+            and check_file_exist(KLIPPER_EXTENSIONS_PATH.joinpath("autotune_tmc.py"))
+            and check_file_exist(KLIPPER_EXTENSIONS_PATH.joinpath("motor_constants.py"))
+            and check_file_exist(KLIPPER_EXTENSIONS_PATH.joinpath("motor_database.cfg"))
+        )
+
+        overwrite = True
+        if tmca_exists:
+            overwrite = get_confirm(
+                question="Extension seems to be installed already. Overwrite?",
+                default_choice=True,
+                allow_go_back=False,
+            )
+
+        if not overwrite:
+            Logger.print_warn("Installation aborted due to user request.")
+            return
+
+        add_moonraker_update_section = get_confirm(
+            question="Add Klipper TMC Autotune to Moonraker update manager(s)?",
+            default_choice=True,
+            allow_go_back=False,
+        )
+
+        create_example_config = get_confirm(
+            question="Create an example autotune_tmc.cfg for each instance?",
+            default_choice=True,
+            allow_go_back=False,
+        )
+
+        kl_instances: List[Klipper] = get_instances(Klipper)
+
+        if not stop_klipper_instances_interactively(
+            kl_instances, "installation of TMC Autotune"
+        ):
+            return
+
+        try:
+            git_clone_wrapper(TMCA_REPO, TMCA_DIR, force=True)
+
+            Logger.print_info("Creating symlinks in Klipper extras directory...")
+            create_symlink(
+                TMCA_DIR.joinpath("autotune_tmc.py"),
+                KLIPPER_EXTENSIONS_PATH.joinpath("autotune_tmc.py"),
+            )
+            create_symlink(
+                TMCA_DIR.joinpath("motor_constants.py"),
+                KLIPPER_EXTENSIONS_PATH.joinpath("motor_constants.py"),
+            )
+            create_symlink(
+                TMCA_DIR.joinpath("motor_database.cfg"),
+                KLIPPER_EXTENSIONS_PATH.joinpath("motor_database.cfg"),
+            )
+            Logger.print_ok(
+                "Symlinks created successfully for all instances.", end="\n\n"
+            )
+
+            if create_example_config:
+                self._install_example_cfg(kl_instances)
+            else:
+                Logger.print_info(
+                    "Skipping example config creation as per user request."
+                )
+                Logger.print_warn(
+                    "Make sure to create and include an autotune_tmc.cfg in your printer.cfg in order to use the extension!"
+                )
+
+            if add_moonraker_update_section:
+                mr_instances: List[Moonraker] = get_instances(Moonraker)
+                self._add_moonraker_update_manager_section(mr_instances)
+            else:
+                Logger.print_info(
+                    "Skipping update section creation as per user request."
+                )
+                Logger.print_warn(
+                    "Make sure to create the corresponding section in your moonraker.conf in order to have it appear in your frontend update manager!"
+                )
+
+        except Exception as e:
+            Logger.print_error(f"Error during Klipper TMC Autotune installation:\n{e}")
+
+            if kl_instances:
+                InstanceManager.start_all(kl_instances)
+            return
+
+        if kl_instances:
+            InstanceManager.start_all(kl_instances)
+
+        if create_example_config:
+            Logger.print_dialog(
+                DialogType.ATTENTION,
+                [
+                    "Basic configuration files were created per instance. You must edit them to enable the extension.",
+                    "Documentation:",
+                    f"{TMCA_REPO}",
+                    "\n\n",
+                    "IMPORTANT:",
+                    "Define [autotune_tmc] sections ONLY in 'autotune_tmc.cfg'. ",
+                    "Do NOT add them to 'printer.cfg', contrary to official docs. "
+                    "While not fatal, mixing configs breaks file segmentation and is bad practice.",
+                ],
+                margin_bottom=1,
+            )
+
+        Logger.print_ok("Klipper TMC Autotune installed successfully!")
+
+    def update_extension(self, **kwargs) -> None:
+        extension_installed = check_file_exist(TMCA_DIR)
+        if not extension_installed:
+            Logger.print_info("Extension does not seem to be installed! Skipping ...")
+            return
+
+        backup_before_update = get_confirm(
+            question="Backup Klipper TMC Autotune directory before update?",
+            default_choice=True,
+            allow_go_back=True,
+        )
+
+        kl_instances: List[Klipper] = get_instances(Klipper)
+
+        if not stop_klipper_instances_interactively(
+            kl_instances, "update of TMC Autotune"
+        ):
+            return
+
+        Logger.print_status("Updating Klipper TMC Autotune...")
+        try:
+            if backup_before_update:
+                Logger.print_status("Backing up Klipper TMC Autotune directory...")
+                svc = BackupService()
+                svc.backup_directory(
+                    source_path=TMCA_DIR,
+                    backup_name="klipper_tmc_autotune",
+                )
+                Logger.print_ok("Backup completed successfully.")
+
+            git_pull_wrapper(TMCA_DIR)
+
+        except Exception as e:
+            Logger.print_error(f"Error during Klipper TMC Autotune update:\n{e}")
+
+            if kl_instances:
+                InstanceManager.start_all(kl_instances)
+                return
+
+        if kl_instances:
+            InstanceManager.start_all(kl_instances)
+
+        Logger.print_ok("Klipper TMC Autotune updated successfully.", end="\n\n")
+
+    def remove_extension(self, **kwargs) -> None:
+        extension_installed = check_file_exist(TMCA_DIR)
+        if not extension_installed:
+            Logger.print_info("Extension does not seem to be installed! Skipping ...")
+            return
+
+        kl_instances: List[Klipper] = get_instances(Klipper)
+
+        if not stop_klipper_instances_interactively(
+            kl_instances, "removal of TMC Autotune"
+        ):
+            return
+
+        try:
+            Logger.print_info("Removing Klipper TMC Autotune extension ...")
+            run_remove_routines(TMCA_DIR)
+            Logger.print_info("Removing symlinks from Klipper extras directory ...")
+            run_remove_routines(KLIPPER_EXTENSIONS_PATH.joinpath("autotune_tmc.py"))
+            run_remove_routines(KLIPPER_EXTENSIONS_PATH.joinpath("motor_constants.py"))
+            run_remove_routines(KLIPPER_EXTENSIONS_PATH.joinpath("motor_database.cfg"))
+
+            mr_instances: List[Moonraker] = get_instances(Moonraker)
+            self._remove_moonraker_update_manager_section(mr_instances)
+
+            Logger.print_info("Removing include from printer.cfg files ...")
+            BackupService().backup_printer_cfg()
+            remove_config_section("include autotune_tmc.cfg", kl_instances)
+
+            Logger.print_dialog(
+                DialogType.ATTENTION,
+                [
+                    "Manual edits to 'printer.cfg' may be required if using exotic stepper configurations.",
+                    "\n\n",
+                    "NOTE:",
+                    "'autotune_tmc.cfg' is NOT removed automatically. ",
+                    "Please delete it manually if no longer needed.",
+                ],
+                margin_bottom=1,
+            )
+
+        except Exception as e:
+            Logger.print_error(f"Unable to remove extension:\n{e}")
+
+            if kl_instances:
+                InstanceManager.start_all(kl_instances)
+            return
+
+        if kl_instances:
+            InstanceManager.start_all(kl_instances)
+
+        Logger.print_ok("Klipper TMC Autotune removed successfully.")
+
+    def _install_example_cfg(self, kl_instances: List[Klipper]):
+        cfg_dirs = [instance.base.cfg_dir for instance in kl_instances]
+
+        for cfg_dir in cfg_dirs:
+            Logger.print_status(f"Create autotune_tmc.cfg in '{cfg_dir}' ...")
+            if check_file_exist(cfg_dir.joinpath("autotune_tmc.cfg")):
+                Logger.print_info("File already exists! Skipping ...")
+                continue
+            try:
+                shutil.copy(TMCA_EXAMPLE_CONFIG, cfg_dir.joinpath("autotune_tmc.cfg"))
+                Logger.print_ok("Done!")
+            except OSError as e:
+                Logger.print_error(f"Unable to create example config: {e}")
+
+        BackupService().backup_printer_cfg()
+
+        section = "include autotune_tmc.cfg"
+        cfg_files = [instance.cfg_file for instance in kl_instances]
+        for cfg_file in cfg_files:
+            Logger.print_status(f"Include autotune_tmc.cfg in '{cfg_file}' ...")
+            scp = SimpleConfigParser()
+            scp.read_file(cfg_file)
+            if scp.has_section(section):
+                Logger.print_info("Section already defined! Skipping ...")
+                continue
+            scp.add_section(section)
+            scp.write_file(cfg_file)
+            Logger.print_ok("Done!")
+
+    def _add_moonraker_update_manager_section(
+        self, mr_instances: List[Moonraker]
+    ) -> None:
+        if not mr_instances:
+            Logger.print_dialog(
+                DialogType.WARNING,
+                [
+                    "Moonraker not found! Klipper TMC Autotune update manager support "
+                    "for Moonraker will not be added to moonraker.conf.",
+                ],
+            )
+            if not get_confirm(
+                "Continue Klipper TMC Autotune installation?",
+                default_choice=False,
+                allow_go_back=True,
+            ):
+                Logger.print_info("Installation aborted due to user request.")
+                return
+
+        BackupService().backup_moonraker_conf()
+
+        add_config_section(
+            section=TMCA_MOONRAKER_UPDATER_NAME,
+            instances=mr_instances,
+            options=[
+                ("type", "git_repo"),
+                ("channel", "dev"),
+                ("path", TMCA_DIR.as_posix()),
+                ("origin", TMCA_REPO),
+                ("managed_services", "klipper"),
+                ("primary_branch", "main"),
+            ],
+        )
+
+        InstanceManager.restart_all(mr_instances)
+
+        Logger.print_ok(
+            "Klipper TMC Autotune successfully added to Moonraker update manager(s)!"
+        )
+
+    def _remove_moonraker_update_manager_section(
+        self, mr_instances: List[Moonraker]
+    ) -> None:
+        if not mr_instances:
+            Logger.print_dialog(
+                DialogType.WARNING,
+                [
+                    "Moonraker not found! Klipper TMC Autotune update manager support "
+                    "for Moonraker will not be removed from moonraker.conf.",
+                ],
+            )
+            return
+
+        BackupService().backup_moonraker_conf()
+
+        remove_config_section("update_manager klipper_tmc_autotune", mr_instances)
+        InstanceManager.restart_all(mr_instances)
+
+        Logger.print_ok(
+            "Klipper TMC Autotune successfully removed from Moonraker update manager(s)!"
+        )

kiauh/procedures/switch_repo.py

@@ -31,6 +31,7 @@ from components.moonraker.services.moonraker_setup_service import (
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import Logger
 from core.services.backup_service import BackupService
+from core.settings.kiauh_settings import KiauhSettings
 from utils.git_utils import GitException, git_clone_wrapper
 from utils.instance_utils import get_instances
 from utils.sys_utils import (
@@ -47,6 +48,11 @@ class RepoSwitchFailedException(Exception):
 def run_switch_repo_routine(
     name: Literal["klipper", "moonraker"], repo_url: str, branch: str
 ) -> None:
+    if name not in ("klipper", "moonraker"):
+        raise ValueError(
+            f"Invalid name: {name!r}. Must be 'klipper' or 'moonraker'."
+        )
+        
     repo_dir: Path = KLIPPER_DIR if name == "klipper" else MOONRAKER_DIR
     env_dir: Path = KLIPPER_ENV_DIR if name == "klipper" else MOONRAKER_ENV_DIR
     req_file = KLIPPER_REQ_FILE if name == "klipper" else MOONRAKER_REQ_FILE
@@ -89,7 +95,16 @@ def run_switch_repo_routine(
 
         # step 6: recreate python virtualenv
         Logger.print_status(f"Recreating {_type.__name__} virtualenv ...")
-        if not create_python_venv(env_dir, force=True):
+
+        settings = KiauhSettings()
+        if name == "klipper":
+            use_python_binary = settings.klipper.use_python_binary
+        elif name == "moonraker":
+            use_python_binary = settings.moonraker.use_python_binary
+            
+        if not create_python_venv(
+            env_dir, force=True, use_python_binary=use_python_binary
+        ):
             raise GitException(f"Failed to recreate virtualenv for {_type.__name__}")
         else:
             install_python_requirements(env_dir, req_file)

kiauh/utils/common.py

@@ -42,7 +42,7 @@ def get_kiauh_version() -> str:
     Helper method to get the current KIAUH version by reading the latest tag
     :return: string of the latest tag or a default value if no tags exist
     """
-    tags = get_local_tags(Path(__file__).parent.parent)
+    tags: List[str] = get_local_tags(Path(__file__).parent.parent)
     if tags:
         return tags[-1]
     else:
@@ -108,7 +108,7 @@ def get_install_status(
     from utils.instance_utils import get_instances
 
     checks = []
-    branch: str = ""
+    branch: str | None = None
 
     if repo_dir.exists():
         checks.append(True)

kiauh/utils/config_utils.py

@@ -14,7 +14,7 @@ from pathlib import Path
 from typing import List, Tuple, Union
 
 from core.logger import Logger
-from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+from core.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
 from utils.instance_type import InstanceType

kiauh/utils/fs_utils.py

@@ -24,13 +24,16 @@ from core.logger import Logger
 
 def check_file_exist(file_path: Path, sudo=False) -> bool:
     """
-    Helper function for checking the existence of a file |
+    Helper function for checking the existence of a file.
+    Also works with symlinks (returns False if broken) |
     :param file_path: the absolute path of the file to check
     :param sudo: use sudo if required
     :return: True, if file exists, otherwise False
     """
     if sudo:
-        command = ["sudo", "find", file_path.as_posix()]
+        # -L forces find to follow symlinks
+        # -maxdepth = 0 avoids losing time if `file_path` is a directory
+        command = ["sudo", "find", "-L", file_path.as_posix(), "-maxdepth", "0"]
         try:
             check_output(command, stderr=DEVNULL)
             return True
@@ -44,7 +47,16 @@ def check_file_exist(file_path: Path, sudo=False) -> bool:
 
 
 def create_symlink(source: Path, target: Path, sudo=False) -> None:
+    """
+    Helper function to create a symlink from source to target
+    If the target file exists, it will be overwritten. |
+    :param source: the source file/directory
+    :param target: the target file/directory
+    :param sudo: use sudo if required
+    :return: None
+    """
     try:
+        # -f forcibly creates/overwrites the symlink
         cmd = ["ln", "-sf", source.as_posix(), target.as_posix()]
         if sudo:
             cmd.insert(0, "sudo")