machineconfig 3.3__py3-none-any.whl → 3.7__py3-none-any.whl

machineconfig/utils/installer_utils/installer_class.py

@@ -1,8 +1,8 @@
-from machineconfig.utils.path_reduced import PathExtended as PathExtended
+from machineconfig.utils.path_extended import PathExtended as PathExtended
 from machineconfig.utils.installer_utils.installer_abc import find_move_delete_linux, find_move_delete_windows
 from machineconfig.utils.source_of_truth import INSTALL_TMP_DIR, INSTALL_VERSION_ROOT, LIBRARY_ROOT
 from machineconfig.utils.options import check_tool_exists
-from machineconfig.utils.utils2 import read_json
+from machineconfig.utils.io import read_json
 from machineconfig.utils.schemas.installer.installer_types import InstallerData, InstallerDataFiles
 
 import platform
@@ -37,12 +37,12 @@ class Installer:
     @staticmethod
     def choose_app_and_install():
         print(f"\n{'=' * 80}\n🔍 SELECT APPLICATION TO INSTALL 🔍\n{'=' * 80}")
-        from machineconfig.utils.options import choose_one_option
+        from machineconfig.utils.options import choose_from_options
 
         print("📂 Searching for configuration files...")
         jobs_dir = Path(LIBRARY_ROOT.joinpath("jobs"))
         config_paths = [Path(p) for p in jobs_dir.rglob("config.json")]
-        path = choose_one_option(options=config_paths)
+        path = choose_from_options(multi=False, options=config_paths, msg="Choose one option")
         print(f"📄 Loading configuration from: {path}")
         config_data = read_json(path)
         installer_data_files = InstallerDataFiles(config_data)
@@ -50,7 +50,7 @@ class Installer:
         # Extract app names from the installers
         app_names = [installer["appName"] for installer in installer_data_files["installers"]]
         print("🔍 Select an application to install:")
-        app_name = choose_one_option(options=app_names, fzf=True)
+        app_name = choose_from_options(multi=False, options=app_names, fzf=True, msg="Choose one option")
 
         # Find the selected installer data
         selected_installer_data = None

machineconfig/utils/io.py

@@ -0,0 +1,94 @@
+from __future__ import annotations
+
+from typing import Any, Union, Optional, Mapping
+from pathlib import Path
+import json
+import pickle
+import configparser
+
+
+PathLike = Union[str, Path]
+
+
+def _ensure_parent(path: PathLike) -> Path:
+    path_obj = Path(path)
+    path_obj.parent.mkdir(parents=True, exist_ok=True)
+    return path_obj
+
+
+def save_pickle(obj: Any, path: PathLike, verbose: bool = False) -> Path:
+    path_obj = _ensure_parent(path)
+    with open(path_obj, "wb") as fh:
+        pickle.dump(obj, fh, protocol=pickle.HIGHEST_PROTOCOL)
+    if verbose:
+        print(f"Saved pickle -> {path_obj}")
+    return Path(path_obj)
+
+
+def save_json(obj: Any, path: PathLike, indent: Optional[int] = None, verbose: bool = False) -> Path:
+    path_obj = _ensure_parent(path)
+    with open(path_obj, "w", encoding="utf-8") as fh:
+        json.dump(obj, fh, indent=indent, ensure_ascii=False)
+        fh.write("\n")
+    if verbose:
+        print(f"Saved json -> {path_obj}")
+    return Path(path_obj)
+
+
+# def save_toml(obj: Mapping[str, Any], path: PathLike, verbose: bool = False) -> Path:
+#     path_obj = _ensure_parent(path)
+#     with open(path_obj, "w", encoding="utf-8") as fh:
+#         toml.dump(obj, fh)
+#     if verbose:
+#         print(f"Saved toml -> {path_obj}")
+#     return Path(path_obj)
+
+
+# def save_yaml(obj: Any, path: PathLike, verbose: bool = False) -> Path:
+#     path_obj = _ensure_parent(path)
+#     with open(path_obj, "w", encoding="utf-8") as fh:
+#         yaml.safe_dump(obj, fh, sort_keys=False)
+#     if verbose:
+#         print(f"Saved yaml -> {path_obj}")
+#     return Path(path_obj)
+
+
+def save_ini(path: PathLike, obj: Mapping[str, Mapping[str, Any]], verbose: bool = False) -> Path:
+    cp = configparser.ConfigParser()
+    for section, values in obj.items():
+        cp[section] = {str(k): str(v) for k, v in values.items()}
+    path_obj = _ensure_parent(path)
+    with open(path_obj, "w", encoding="utf-8") as fh:
+        cp.write(fh)
+    if verbose:
+        print(f"Saved ini -> {path_obj}")
+    return Path(path_obj)
+
+
+def read_ini(path: "Path", encoding: Optional[str] = None):
+    if not Path(path).exists() or Path(path).is_dir():
+        raise FileNotFoundError(f"File not found or is a directory: {path}")
+    import configparser
+
+    res = configparser.ConfigParser()
+    res.read(filenames=[str(path)], encoding=encoding)
+    return res
+
+
+def read_json(path: "Path", r: bool = False, **kwargs: Any) -> Any:  # return could be list or dict etc
+    import json
+
+    try:
+        mydict = json.loads(Path(path).read_text(encoding="utf-8"), **kwargs)
+    except Exception:
+        import pyjson5
+
+        mydict = pyjson5.loads(Path(path).read_text(encoding="utf-8"), **kwargs)  # file has C-style comments.
+    _ = r
+    return mydict
+
+
+def from_pickle(path: Path) -> Any:
+    import pickle
+
+    return pickle.loads(path.read_bytes())

machineconfig/utils/links.py

@@ -1,5 +1,5 @@
-from machineconfig.utils.path_reduced import PathExtended as PathExtended, PLike
-from machineconfig.utils.utils2 import randstr
+from machineconfig.utils.path_extended import PathExtended as PathExtended, PLike
+from machineconfig.utils.accessories import randstr
 from rich.console import Console
 from rich.panel import Panel
 

machineconfig/utils/notifications.py

@@ -1,16 +1,8 @@
 """Notifications Module"""
 
-# from crocodile.core import install_n_import
-# from crocodile.file_management import P, Read
 from pathlib import Path
-
-# from crocodile.meta import RepeatUntilNoException
 import smtplib
 import imaplib
-
-# from email import message
-# from email import encoders
-# from email.mime.base import MIMEBase
 from email.mime.text import MIMEText
 from email.mime.multipart import MIMEMultipart
 from typing import Optional, Any, Union
@@ -192,7 +184,6 @@ encryption = ssl
     #     else:
     #         body_file_path = None
     #         assert body is not None, "You must pass either body or body_file."
-    #     from crocodile.meta import Terminal
 
     #     to_str = ",".join(to)
     #     attachments_str = " ".join([f"--attachment {str(p)}" for p in attachments]) if attachments is not None else ""

machineconfig/utils/options.py

@@ -4,7 +4,7 @@ from rich.panel import Panel
 from rich.console import Console
 import platform
 import subprocess
-from typing import Optional, Union, Iterable
+from typing import Optional, Union, Iterable, overload, Literal
 from machineconfig.utils.source_of_truth import WINDOWS_INSTALL_PATH, LINUX_INSTALL_PATH
 
 
@@ -32,20 +32,23 @@ def check_tool_exists(tool_name: str) -> bool:
     # return root_path.joinpath(tool_name).is_file()
 
 
-def choose_one_option[T](options: Iterable[T], header: str = "", tail: str = "", prompt: str = "", msg: str = "", default: Optional[T] = None, fzf: bool = False, custom_input: bool = False) -> T:
-    choice_key = display_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt, default=default, fzf=fzf, multi=False, custom_input=custom_input)
-    assert not isinstance(choice_key, list)
-    return choice_key
+# def choose_from_options[T](options: Iterable[T], header: str = "", tail: str = "", prompt: str = "", msg: str = "", default: Optional[T] = None, fzf: bool = False, custom_input: bool = False) -> T:
+#     choice_key = choose_from_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt, default=default, fzf=fzf, multi=False, custom_input=custom_input)
+#     assert not isinstance(choice_key, list)
+#     return choice_key
 
 
-def choose_multiple_options[T](options: Iterable[T], header: str = "", tail: str = "", prompt: str = "", msg: str = "", default: Optional[T] = None, custom_input: bool = False) -> list[T]:
-    choice_key = display_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt, default=default, fzf=True, multi=True, custom_input=custom_input)
-    if isinstance(choice_key, list):
-        return choice_key
-    return [choice_key]
+# def choose_from_options[T](options: Iterable[T], header: str = "", tail: str = "", prompt: str = "", msg: str = "", default: Optional[T] = None, custom_input: bool = False) -> list[T]:
+#     choice_key = choose_from_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt, default=default, fzf=True, multi=True, custom_input=custom_input)
+#     if isinstance(choice_key, list):
+#         return choice_key
+#     return [choice_key]
 
-
-def display_options[T](msg: str, options: Iterable[T], header: str = "", tail: str = "", prompt: str = "", default: Optional[T] = None, fzf: bool = False, multi: bool = False, custom_input: bool = False) -> Union[T, list[T]]:
+@overload
+def choose_from_options[T](msg: str, options: Iterable[T], multi: Literal[False], custom_input: bool = False, header: str = "", tail: str = "", prompt: str = "", default: Optional[T] = None, fzf: bool = False) -> T: ...
+@overload
+def choose_from_options[T](msg: str, options: Iterable[T], multi: Literal[True], custom_input: bool = True, header: str = "", tail: str = "", prompt: str = "", default: Optional[T] = None, fzf: bool = False, ) -> list[T]: ...
+def choose_from_options[T](msg: str, options: Iterable[T], multi: bool, custom_input: bool = True, header: str = "", tail: str = "", prompt: str = "", default: Optional[T] = None, fzf: bool = False, ) -> Union[T, list[T]]:
     # TODO: replace with https://github.com/tmbo/questionary
     # # also see https://github.com/charmbracelet/gum
     tool_name = "fzf"
@@ -90,7 +93,7 @@ def display_options[T](msg: str, options: Iterable[T], header: str = "", tail: s
         if choice_string == "":
             if default_string is None:
                 console.print(Panel("🧨 Default option not available!", title="Error", expand=False))
-                return display_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt, default=default, fzf=fzf, multi=multi, custom_input=custom_input)
+                return choose_from_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt, default=default, fzf=fzf, multi=multi, custom_input=custom_input)
             choice_idx = options_strings.index(default_string)
             assert default is not None, "🧨 Default option not available!"
             choice_one: T = default
@@ -108,7 +111,7 @@ def display_options[T](msg: str, options: Iterable[T], header: str = "", tail: s
                     _ = ie
                     # raise ValueError(f"Unknown choice. {choice_string}") from ie
                     console.print(Panel(f"❓ Unknown choice: '{choice_string}'", title="Error", expand=False))
-                    return display_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt, default=default, fzf=fzf, multi=multi, custom_input=custom_input)
+                    return choose_from_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt, default=default, fzf=fzf, multi=multi, custom_input=custom_input)
             except TypeError as te:  # int(choice_string) failed due to # either the number is invalid, or the input is custom.
                 if choice_string in options_strings:  # string input
                     choice_idx = options_strings.index(choice_one)  # type: ignore
@@ -119,7 +122,7 @@ def display_options[T](msg: str, options: Iterable[T], header: str = "", tail: s
                     _ = te
                     # raise ValueError(f"Unknown choice. {choice_string}") from te
                     console.print(Panel(f"❓ Unknown choice: '{choice_string}'", title="Error", expand=False))
-                    return display_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt, default=default, fzf=fzf, multi=multi, custom_input=custom_input)
+                    return choose_from_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt, default=default, fzf=fzf, multi=multi, custom_input=custom_input)
         console.print(Panel(f"✅ Selected option {choice_idx}: {choice_one}", title="Selected", expand=False))
         if multi:
             return [choice_one]
@@ -138,7 +141,7 @@ def choose_cloud_interactively() -> str:
         raise ValueError(f"Got {tmp} from rclone listremotes")
     if len(remotes) == 0:
         raise RuntimeError("You don't have remotes. Configure your rclone first to get cloud services access.")
-    cloud: str = choose_one_option(msg="WHICH CLOUD?", options=list(remotes), default=remotes[0], fzf=True)
+    cloud: str = choose_from_options(msg="WHICH CLOUD?", multi=False, options=list(remotes), default=remotes[0], fzf=True)
     console.print(Panel(f"✅ SELECTED CLOUD | {cloud}", border_style="bold blue", expand=False))
     return cloud
 
@@ -151,5 +154,9 @@ def get_ssh_hosts() -> list[str]:
     return list(c.get_hostnames())
 
 
-def choose_ssh_host(multi: bool = True):
-    return display_options(msg="", options=get_ssh_hosts(), multi=multi, fzf=True)
+@overload
+def choose_ssh_host(multi: Literal[False]) -> str: ...
+@overload
+def choose_ssh_host(multi: Literal[True]) -> list[str]: ...
+def choose_ssh_host(multi: bool):
+    return choose_from_options(msg="", options=get_ssh_hosts(), multi=multi, fzf=True)

machineconfig/utils/{path_reduced.py → path_extended.py}

@@ -1,4 +1,4 @@
-from machineconfig.utils.utils2 import randstr
+from machineconfig.utils.accessories import randstr
 
 from datetime import datetime
 import time

machineconfig/utils/{path.py → path_helper.py}

@@ -1,5 +1,5 @@
-from machineconfig.utils.path_reduced import PathExtended as PathExtended
-from machineconfig.utils.options import choose_one_option
+from machineconfig.utils.path_extended import PathExtended as PathExtended
+from machineconfig.utils.options import choose_from_options
 from machineconfig.utils.source_of_truth import EXCLUDE_DIRS
 from rich.console import Console
 from rich.panel import Panel
@@ -83,7 +83,7 @@ def match_file_name(sub_string: str, search_root: PathExtended, suffixes: set[st
         if len(reduced_scripts) == 1:
             return PathExtended(reduced_scripts[0])
         elif len(reduced_scripts) > 1:
-            choice = choose_one_option(msg="Multiple matches found", options=reduced_scripts, fzf=True)
+            choice = choose_from_options(multi=False, msg="Multiple matches found", options=reduced_scripts, fzf=True)
             return PathExtended(choice)
         print(f"Result: This still generated {len(reduced_scripts)} results.")
         if len(reduced_scripts) < 10:

machineconfig/utils/procs.py

@@ -3,12 +3,12 @@
 import psutil
 from rich.progress import Progress, SpinnerColumn, TextColumn
 from zoneinfo import ZoneInfo
-from machineconfig.utils.options import display_options
+from machineconfig.utils.options import choose_from_options
 from typing import Optional, Any
 from rich.console import Console
 from rich.panel import Panel
 from datetime import datetime, timezone
-from machineconfig.utils.utils2 import pprint
+from machineconfig.utils.accessories import pprint
 
 console = Console()
 
@@ -120,7 +120,7 @@ class ProcessManager:
         # Format data as table for display
         formatted_data = self._format_process_table()
         options = formatted_data.split("\n")[1:]  # Skip header
-        res = display_options(options=formatted_data.split("\n"), msg="📋 Select processes to manage:", fzf=True, multi=True)
+        res = choose_from_options(options=formatted_data.split("\n"), msg="📋 Select processes to manage:", fzf=True, multi=True)
         indices = [options.index(val) for val in res]
         selected_processes = [self.data[i] for i in indices]
 

machineconfig/utils/{utils5.py → scheduler.py}

@@ -3,7 +3,8 @@ from typing import Callable, Optional, Union, Any, NoReturn, TypeVar, Protocol,
 import logging
 import time
 from datetime import datetime, timezone, timedelta
-from machineconfig.utils.path_reduced import PathExtended as PathExtended
+from machineconfig.utils.io import from_pickle
+from machineconfig.utils.path_extended import PathExtended as PathExtended
 
 
 class LoggerTemplate(Protocol):
@@ -108,7 +109,7 @@ class Scheduler:
             # "logfile": self.logger.file_path
         }
         summ.update(sess_stats)
-        from machineconfig.utils.utils2 import get_repr
+        from machineconfig.utils.accessories import get_repr
 
         tmp = get_repr(summ)
         self.logger.critical("\n--> Scheduler has finished running a session. \n" + tmp + "\n" + "-" * 100)
@@ -157,12 +158,6 @@ def to_pickle(obj: Any, path: Path) -> None:
     path.write_bytes(pickle.dumps(obj))
 
 
-def from_pickle(path: Path) -> Any:
-    import pickle
-
-    return pickle.loads(path.read_bytes())
-
-
 class Cache(Generic[T]):  # This class helps to accelrate access to latest data coming from expensive function. The class has two flavours, memory-based and disk-based variants."""
     # source_func: Callable[[], T]
     def __init__(

machineconfig/utils/scheduling.py

@@ -207,12 +207,12 @@
 #     for a_dir in tasks_dirs:
 #         tasks.append(read_task_from_dir(a_dir))
 
-#     from machineconfig.utils.utils import choose_multiple_options
+#     from machineconfig.utils.utils import choose_from_options
 
 #     # Create data for tasks display
 #     task_data = [Report.from_path(path=a_task.report_path).__dict__ for a_task in tasks]
 #     task_display = format_table_markdown(task_data)
-#     tasks_chosen_raw = choose_multiple_options(task_display.splitlines(), "📋 Choose tasks to run")
+#     tasks_chosen_raw = choose_from_options(multi=True, task_display.splitlines(), "📋 Choose tasks to run")
 #     tasks_chosen = [tasks[int(a_task_chosen.split("|")[1])] for a_task_chosen in tasks_chosen_raw]
 
 #     print(f"""

machineconfig/utils/ssh.py

@@ -3,8 +3,8 @@ import os
 from dataclasses import dataclass
 import rich.console
 from machineconfig.utils.terminal import Terminal, Response, MACHINE
-from machineconfig.utils.path_reduced import PathExtended, PLike, OPLike
-from machineconfig.utils.utils2 import pprint
+from machineconfig.utils.path_extended import PathExtended, PLike, OPLike
+from machineconfig.utils.accessories import pprint
 # from machineconfig.utils.ve import get_ve_activate_line
 
 

machineconfig/utils/terminal.py

@@ -1,4 +1,4 @@
-from machineconfig.utils.path_reduced import PathExtended, OPLike
+from machineconfig.utils.path_extended import PathExtended, OPLike
 import subprocess
 from typing import Any, BinaryIO, Optional, Union
 import platform
@@ -219,9 +219,19 @@ class Terminal:
 
     @staticmethod
     def get_header(wdir: OPLike, toolbox: bool):
+        if toolbox:
+            toobox_code = """
+try:
+    from crocodile.toolbox import *
+except ImportError:
+    print("Crocodile not found, skipping import.")
+    pass
+"""
+        else:
+            toobox_code = "# No toolbox import."
         return f"""
 # >> Code prepended
-{"from crocodile.toolbox import *" if toolbox else "# No toolbox import."}
+{toobox_code}
 {'''sys.path.insert(0, r'{wdir}') ''' if wdir is not None else "# No path insertion."}
 # >> End of header, start of script passed
 """

machineconfig/utils/ve.py

@@ -1,8 +1,7 @@
-from machineconfig.utils.path_reduced import PathExtended as PathExtended
-from machineconfig.utils.utils2 import read_ini
+from machineconfig.utils.path_extended import PathExtended as PathExtended
+from machineconfig.utils.io import read_ini
 import platform
 from typing import Optional
-from pathlib import Path
 
 
 def get_ve_path_and_ipython_profile(init_path: PathExtended) -> tuple[Optional[str], Optional[str]]:
@@ -39,19 +38,6 @@ def get_ve_path_and_ipython_profile(init_path: PathExtended) -> tuple[Optional[s
     return ve_path, ipy_profile
 
 
-def get_repo_root(path: Path) -> Optional[Path]:
-    from git import Repo, InvalidGitRepositoryError
-
-    try:
-        repo = Repo(str(path), search_parent_directories=True)
-        root = repo.working_tree_dir
-        if root is not None:
-            return Path(root)
-    except InvalidGitRepositoryError:
-        pass
-    return None
-
-
 def get_ve_activate_line(ve_root: str):
     if platform.system() == "Windows":
         activate_ve_line = f". {ve_root}/Scripts/activate.ps1"

{machineconfig-3.3.dist-info → machineconfig-3.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: machineconfig
-Version: 3.3
+Version: 3.7
 Summary: Dotfiles management package
 Author-email: Alex Al-Saffar <programmer@usa.com>
 License: Apache 2.0
@@ -24,9 +24,6 @@ Requires-Dist: gitpython>=3.1.44
 Requires-Dist: pyfzf>=0.3.1
 Requires-Dist: rclone-python>=0.1.23
 Requires-Dist: pyjson5>=1.6.9
-Requires-Dist: pyyaml>=6.0.2
-Requires-Dist: toml>=0.10.2
-Requires-Dist: tomli>=2.2.1
 Provides-Extra: windows
 Requires-Dist: pywin32; extra == "windows"
 Provides-Extra: docs