machineconfig 5.19__tar.gz → 5.20__tar.gz

{machineconfig-5.19/src/machineconfig.egg-info → machineconfig-5.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: machineconfig
-Version: 5.19
+Version: 5.20
 Summary: Dotfiles management package
 Author-email: Alex Al-Saffar <programmer@usa.com>
 License: Apache 2.0

{machineconfig-5.19 → machineconfig-5.20}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "machineconfig"
-version = "5.19"
+version = "5.20"
 description = "Dotfiles management package"
 readme = "README.md"
 license = {text = "Apache 2.0"}

{machineconfig-5.19 → machineconfig-5.20}/src/machineconfig/profile/create.py

@@ -4,6 +4,7 @@ This script Takes away all config files from the computer, place them in one dir
 
 """
 
+from machineconfig.utils.links import OperationRecord
 from rich.console import Console
 from rich.panel import Panel
 from rich.pretty import Pretty
@@ -12,7 +13,7 @@ from rich.table import Table
 
 from machineconfig.utils.path_extended import PathExtended
 from machineconfig.utils.links import symlink_map, copy_map
-from machineconfig.utils.source_of_truth import LIBRARY_ROOT
+from machineconfig.utils.source_of_truth import LIBRARY_ROOT, CONFIG_PATH
 
 import platform
 import subprocess
@@ -40,7 +41,6 @@ class Base(TypedDict):
     to_this: str
     contents: Optional[bool]
     copy: Optional[bool]
-
 class ConfigMapper(TypedDict):
     file_name: str
     config_file_default_path: str
@@ -74,31 +74,6 @@ def read_mapper() -> MapperFileData:
     return {"public": public, "private": private}
 
 
-class OperationRecord(TypedDict):
-    program: str
-    file_key: str
-    source: str
-    target: str
-    operation: str
-    action: Literal[
-        "already_linked",
-        "relinking", 
-        "fixing_broken_link",
-        "identical_files",
-        "backing_up_source",
-        "backing_up_target", 
-        "relinking_to_new_target",
-        "moving_to_target",
-        "new_link",
-        "new_link_and_target",
-        "linking",
-        "copying",
-        "error"
-    ]
-    details: str
-    status: str
-
-
 def apply_mapper(mapper_data: dict[str, list[ConfigMapper]],
                  on_conflict: Literal["throwError", "overwriteSelfManaged", "backupSelfManaged", "overwriteDefaultPath", "backupDefaultPath"],
                  method: Literal["symlink", "copy"]
@@ -135,80 +110,104 @@ def apply_mapper(mapper_data: dict[str, list[ConfigMapper]],
             self_managed_config_file_path = PathExtended(a_mapper["self_managed_config_file_path"].replace("LIBRARY_ROOT", LIBRARY_ROOT.as_posix()))
             
             # Determine whether to use copy or symlink
-            use_copy = method == "copy" or "copy" in a_mapper
+            use_copy = method == "copy" or a_mapper.get("copy", False)
             
             if "contents" in a_mapper:
-                try:
-                    targets = list(self_managed_config_file_path.expanduser().search("*"))
-                    for a_target in targets:
+                targets = list(self_managed_config_file_path.expanduser().search("*"))
+                for a_target in targets:
+                    operation_type = "contents_copy" if use_copy else "contents_symlink"
+                    try:
                         if use_copy:
                             result = copy_map(config_file_default_path=config_file_default_path.joinpath(a_target.name), self_managed_config_file_path=a_target, on_conflict=on_conflict)
-                            operation_type = "contents_copy"
                         else:
                             result = symlink_map(config_file_default_path=config_file_default_path.joinpath(a_target.name), self_managed_config_file_path=a_target, on_conflict=on_conflict)
-                            operation_type = "contents_symlink"
                         operation_records.append({
                             "program": program_name,
                             "file_key": a_mapper["file_name"],
-                            "source": str(config_file_default_path.joinpath(a_target.name)),
-                            "target": str(a_target),
+                            "defaultPath": str(config_file_default_path.joinpath(a_target.name)),
+                            "selfManaged": str(a_target),
                             "operation": operation_type,
                             "action": result["action"],
                             "details": result["details"],
                             "status": "success"
                         })
-                except Exception as ex:
-                    console.print(f"❌ [red]Config error[/red]: {program_name} | {a_mapper['file_name']} | missing keys 'config_file_default_path ==> self_managed_config_file_path'. {ex}")
-                    operation_records.append({
-                        "program": program_name,
-                        "file_key": a_mapper["file_name"],
-                        "source": str(config_file_default_path),
-                        "target": str(self_managed_config_file_path),
-                        "operation": "contents_symlink" if not use_copy else "contents_copy",
-                        "action": "error",
-                        "details": f"Failed to process contents: {str(ex)}",
-                        "status": f"error: {str(ex)}"
-                    })                    
+                    except ValueError as ex:
+                        if "resolve to the same location" in str(ex):
+                            operation_records.append({
+                                "program": program_name,
+                                "file_key": a_mapper["file_name"],
+                                "defaultPath": str(config_file_default_path.joinpath(a_target.name)),
+                                "selfManaged": str(a_target),
+                                "operation": operation_type,
+                                "action": "already_linked",
+                                "details": "defaultPath and selfManaged resolve to same location - already correctly configured",
+                                "status": "success"
+                            })
+                        else:
+                            raise
+                    except Exception as ex:
+                        console.print(f"❌ [red]Config error[/red]: {program_name} | {a_mapper['file_name']} | {a_target.name}. {ex}")
+                        operation_records.append({
+                            "program": program_name,
+                            "file_key": a_mapper["file_name"],
+                            "defaultPath": str(config_file_default_path.joinpath(a_target.name)),
+                            "selfManaged": str(a_target),
+                            "operation": operation_type,
+                            "action": "error",
+                            "details": f"Failed to process contents: {str(ex)}",
+                            "status": f"error: {str(ex)}"
+                        })                    
             else:
+                operation_type = "copy" if use_copy else "symlink"
                 try:
                     if use_copy:
                         result = copy_map(config_file_default_path=config_file_default_path, self_managed_config_file_path=self_managed_config_file_path, on_conflict=on_conflict)
-                        operation_type = "copy"
                     else:
                         result = symlink_map(config_file_default_path=config_file_default_path, self_managed_config_file_path=self_managed_config_file_path, on_conflict=on_conflict)
-                        operation_type = "symlink"
                     operation_records.append({
                         "program": program_name,
                         "file_key": a_mapper["file_name"],
-                        "source": str(config_file_default_path),
-                        "target": str(self_managed_config_file_path),
+                        "defaultPath": str(config_file_default_path),
+                        "selfManaged": str(self_managed_config_file_path),
                         "operation": operation_type,
                         "action": result["action"],
                         "details": result["details"],
                         "status": "success"
                     })
+                except ValueError as ex:
+                    if "resolve to the same location" in str(ex):
+                        operation_records.append({
+                            "program": program_name,
+                            "file_key": a_mapper["file_name"],
+                            "defaultPath": str(config_file_default_path),
+                            "selfManaged": str(self_managed_config_file_path),
+                            "operation": operation_type,
+                            "action": "already_linked",
+                            "details": "defaultPath and selfManaged resolve to same location - already correctly configured",
+                            "status": "success"
+                        })
+                    else:
+                        raise
                 except Exception as ex:
-                    console.print(f"❌ [red]Config error[/red]: {program_name} | {a_mapper['file_name']} | missing keys 'config_file_default_path ==> self_managed_config_file_path'. {ex}")
+                    console.print(f"❌ [red]Config error[/red]: {program_name} | {a_mapper['file_name']} | {ex}")
                     operation_records.append({
                         "program": program_name,
                         "file_key": a_mapper["file_name"],
-                        "source": str(config_file_default_path),
-                        "target": str(self_managed_config_file_path),
-                        "operation": "symlink" if not use_copy else "copy",
+                        "defaultPath": str(config_file_default_path),
+                        "selfManaged": str(self_managed_config_file_path),
+                        "operation": operation_type,
                         "action": "error",
-                        "details": f"Failed to create {'symlink' if not use_copy else 'copy'}: {str(ex)}",
+                        "details": f"Failed to create {operation_type}: {str(ex)}",
                         "status": f"error: {str(ex)}"
                     })
 
             if program_name == "ssh" and system == "Linux":  # permissions of ~/dotfiles/.ssh should be adjusted
                 try:
                     console.print("\n[bold]🔒 Setting secure permissions for SSH files...[/bold]")
-                    # run_shell_script("sudo chmod 600 $HOME/.ssh/*")
-                    # run_shell_script("sudo chmod 700 $HOME/.ssh")
-
-                    subprocess.run("chmod 700 ~/.ssh/", check=True)
-                    subprocess.run("chmod 700 ~/dotfiles/creds/.ssh/", check=True)  # may require sudo
-                    subprocess.run("chmod 600 ~/dotfiles/creds/.ssh/*", check=True)
+                    subprocess.run("chmod 700 $HOME/.ssh/", shell=True, check=True)
+                    subprocess.run("chmod 700 $HOME/dotfiles/creds/.ssh/", shell=True, check=True)
+                    subprocess.run("chmod 600 $HOME/dotfiles/creds/.ssh/*", shell=True, check=True)
+                    subprocess.run("chmod 600 $HOME/.ssh/*", shell=True, check=True)
                     console.print("[green]✅ SSH permissions set successfully[/green]")
                 except Exception as e:
                     ERROR_LIST.append(e)
@@ -224,8 +223,8 @@ def apply_mapper(mapper_data: dict[str, list[ConfigMapper]],
         table = Table(title="🔗 Symlink Operations Summary", show_header=True, header_style="bold magenta")
         table.add_column("Program", style="cyan", no_wrap=True)
         table.add_column("File Key", style="blue", no_wrap=True)
-        table.add_column("Source", style="green")
-        table.add_column("Target", style="yellow")
+        table.add_column("Default Path", style="green")
+        table.add_column("Self Managed", style="yellow")
         table.add_column("Operation", style="magenta", no_wrap=True)
         table.add_column("Action", style="red", no_wrap=True)
         table.add_column("Details", style="white")
@@ -237,8 +236,8 @@ def apply_mapper(mapper_data: dict[str, list[ConfigMapper]],
             table.add_row(
                 record["program"],
                 record["file_key"],
-                record["source"],
-                record["target"],
+                record["defaultPath"],
+                record["selfManaged"],
                 record["operation"],
                 f"[{action_style}]{record['action']}[/{action_style}]",
                 record["details"],
@@ -247,6 +246,25 @@ def apply_mapper(mapper_data: dict[str, list[ConfigMapper]],
         
         console.print("\n")
         console.print(table)
+        
+        # Export operation records to CSV
+        import csv
+        from datetime import datetime
+        
+        csv_dir = PathExtended(CONFIG_PATH).joinpath("symlink_operations")
+        csv_dir.mkdir(parents=True, exist_ok=True)
+        
+        timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
+        csv_filename = f"symlink_operations_{timestamp}.csv"
+        csv_path = csv_dir.joinpath(csv_filename)
+        
+        with open(csv_path, "w", newline="", encoding="utf-8") as csvfile:
+            fieldnames = ["program", "file_key", "defaultPath", "selfManaged", "operation", "action", "details", "status"]
+            writer = csv.DictWriter(csvfile, fieldnames=fieldnames)
+            writer.writeheader()
+            writer.writerows(operation_records)
+        
+        console.print(f"\n[bold green]📊 Operations exported to CSV:[/bold green] [cyan]{csv_path}[/cyan]")
 
     if len(ERROR_LIST) > 0:
         console.print(

{machineconfig-5.19 → machineconfig-5.20}/src/machineconfig/scripts/python/devops.py

@@ -45,22 +45,32 @@ def interactive():
 def status():
     """📊 STATUS of machine, shell profile, apps, symlinks, dotfiles, etc."""
     pass
+@self_app.command()
+def clone():
+    """📋 CLONE machienconfig locally for faster execution and nightly updates. """
+    import platform
+    from machineconfig.utils.code import run_shell_script
+    if platform.system() == "Windows":
+        from machineconfig.setup_windows import REPOS
+    else:
+        from machineconfig.setup_linux import REPOS
+    run_shell_script(REPOS.read_text(encoding="utf-8"))
 
 
 @config_apps.command(no_args_is_help=True)
-def private(method: Literal["symlink", "copy"] = typer.Option(..., help="Method to use for linking files"),
-                             on_conflict: Literal["throwError", "overwriteSelfManaged", "backupSelfManaged", "overwriteDefaultPath", "backupDefaultPath"] = typer.Option("throwError", help="Action to take on conflict"),
-                             which: Optional[str] = typer.Option(None, help="Specific items to process"),
-                             interactive: bool = typer.Option(False, help="Run in interactive mode")):
+def private(method: Literal["symlink", "copy"] = typer.Option(..., "--method", "-m", help="Method to use for linking files"),
+                             on_conflict: Literal["throwError", "overwriteSelfManaged", "backupSelfManaged", "overwriteDefaultPath", "backupDefaultPath"] = typer.Option("throwError", "--on-conflict", "-o", help="Action to take on conflict"),
+                             which: Optional[str] = typer.Option(None, "--which", "-w", help="Specific items to process"),
+                             interactive: bool = typer.Option(False, "--interactive", "-ia", help="Run in interactive mode")):
     """🔗 Manage private configuration files."""
     import machineconfig.profile.create_frontend as create_frontend
     create_frontend.main_private_from_parser(method=method, on_conflict=on_conflict, which=which, interactive=interactive)
 
 @config_apps.command(no_args_is_help=True)
-def public(method: Literal["symlink", "copy"] = typer.Option(..., help="Method to use for setting up the config file."),
-                            on_conflict: Literal["throwError", "overwriteDefaultPath", "backupDefaultPath"] = typer.Option(..., help="Action to take on conflict"),
-                            which: Optional[str] = typer.Option(None, help="Specific items to process"),
-                            interactive: bool = typer.Option(False, help="Run in interactive mode")):
+def public(method: Literal["symlink", "copy"] = typer.Option(..., "--method", "-m", help="Method to use for setting up the config file."),
+                            on_conflict: Literal["throwError", "overwriteDefaultPath", "backupDefaultPath"] = typer.Option("throwError", "--on-conflict", "-o", help="Action to take on conflict"),
+                            which: Optional[str] = typer.Option(None, "--which", "-w", help="Specific items to process"),
+                            interactive: bool = typer.Option(False, "--interactive", "-ia", help="Run in interactive mode")):
     """🔗 Manage public configuration files."""
     import machineconfig.profile.create_frontend as create_frontend
     create_frontend.main_public_from_parser(method=method, on_conflict=on_conflict, which=which, interactive=interactive)

{machineconfig-5.19 → machineconfig-5.20}/src/machineconfig/scripts/python/interactive.py

@@ -19,8 +19,8 @@ for better user experience with checkbox selections.
 
 import sys
 from pathlib import Path
-from platform import system
 from typing import cast
+import platform
 
 import questionary
 from questionary import Choice
@@ -80,14 +80,14 @@ def get_installation_choices() -> list[str]:
         Choice(value="retrieve_data", title="💾 Retrieve Data                  - Backup restoration", checked=False),
     ]
     # Add Windows-specific options
-    if system() == "Windows":
+    if platform.system() == "Windows":
         choices.append(Choice(value="install_windows_desktop", title="💻 Install Windows Desktop Apps   - Brave, Windows Terminal, PowerShell, VSCode (Windows only)", checked=False))
     selected = questionary.checkbox("Select the installation options you want to execute:", choices=choices, show_description=True).ask()
     return selected or []
 
 
 def execute_installations(selected_options: list[str]) -> None:
-    if system() == "Windows":
+    if platform.system() == "Windows":
         from machineconfig import setup_windows as module
         script_path = Path(module.__file__).parent / "ve.ps1"
         run_shell_script(script_path.read_text(encoding="utf-8"))
@@ -109,26 +109,24 @@ def execute_installations(selected_options: list[str]) -> None:
             run_shell_script(". $HOME/.bashrc")
 
     if "upgrade_system" in selected_options:
-        if system() == "Windows":
+        if platform.system() == "Windows":
             console.print("❌ System upgrade is not applicable on Windows via this script.", style="bold red")
-        elif system() == "Linux":
+        elif platform.system() == "Linux":
             console.print(Panel("🔄 [bold magenta]SYSTEM UPDATE[/bold magenta]\n[italic]Package management[/italic]", border_style="magenta"))
             run_shell_script("sudo nala upgrade -y")
         else:
-            console.print(f"❌ System upgrade not supported on {system()}.", style="bold red")
+            console.print(f"❌ System upgrade not supported on {platform.system()}.", style="bold red")
     if "install_repos" in selected_options:
         console.print(Panel("🐍 [bold green]PYTHON ENVIRONMENT[/bold green]\n[italic]Virtual environment setup[/italic]", border_style="green"))
-        if system() == "Windows":
-            from machineconfig import setup_windows as module
-            script_path = Path(module.__file__).parent / "repos.ps1"
+        if platform.system() == "Windows":
+            from machineconfig.setup_windows import REPOS
         else:
-            from machineconfig import setup_linux as module
-            script_path = Path(module.__file__).parent / "repos.sh"
-        run_shell_script(script_path.read_text(encoding="utf-8"))
+            from machineconfig.setup_linux import REPOS
+        run_shell_script(REPOS.read_text(encoding="utf-8"))
 
     if "install_ssh_server" in selected_options:
         console.print(Panel("🔒 [bold red]SSH SERVER[/bold red]\n[italic]Remote access setup[/italic]", border_style="red"))
-        if system() == "Windows":
+        if platform.system() == "Windows":
             powershell_script = """Write-Host "🔧 Installing and configuring SSH server..."
 Add-WindowsCapability -Online -Name OpenSSH.Server~~~~0.0.1.0
 Start-Service sshd

{machineconfig-5.19 → machineconfig-5.20}/src/machineconfig/scripts/python/repos.py

@@ -35,7 +35,7 @@ CloudOption = Annotated[
 
 
 
-@app.command()
+@app.command(no_args_is_help=True)
 def push(directory: DirectoryArgument = None,
     recursive: RecursiveOption = False,
     no_sync: NoSyncOption = False,
@@ -43,7 +43,7 @@ def push(directory: DirectoryArgument = None,
     """🚀 Push changes across repositories."""
     from machineconfig.scripts.python.repos_helper import git_operations
     git_operations(directory, pull=False, commit=False, push=True, recursive=recursive, no_sync=no_sync)
-@app.command()
+@app.command(no_args_is_help=True)
 def pull(
     directory: DirectoryArgument = None,
     recursive: RecursiveOption = False,
@@ -52,7 +52,7 @@ def pull(
     """⬇️ Pull changes across repositories."""
     from machineconfig.scripts.python.repos_helper import git_operations
     git_operations(directory, pull=True, commit=False, push=False, recursive=recursive, no_sync=no_sync)
-@app.command()
+@app.command(no_args_is_help=True)
 def commit(
     directory: DirectoryArgument = None,
     recursive: RecursiveOption = False,
@@ -61,8 +61,8 @@ def commit(
     """💾 Commit changes across repositories."""
     from machineconfig.scripts.python.repos_helper import git_operations
     git_operations(directory, pull=False, commit=True, push=False, recursive=recursive, no_sync=no_sync)
-@app.command()
-def all(
+@app.command(no_args_is_help=True)
+def cleanup(
     directory: DirectoryArgument = None,
     recursive: RecursiveOption = False,
     no_sync: NoSyncOption = False,
@@ -72,7 +72,7 @@ def all(
     git_operations(directory, pull=True, commit=True, push=True, recursive=recursive, no_sync=no_sync)
 
 
-@sync_app.command()
+@sync_app.command(no_args_is_help=True)
 def capture(
     directory: DirectoryArgument = None,
     cloud: CloudOption = None,
@@ -86,7 +86,7 @@ def capture(
     from machineconfig.utils.path_extended import PathExtended
     if cloud is not None:
         PathExtended(save_path).to_cloud(rel2home=True, cloud=cloud)
-@sync_app.command()
+@sync_app.command(no_args_is_help=True)
 def clone(
     directory: DirectoryArgument = None,
     cloud: CloudOption = None,
@@ -97,7 +97,7 @@ def clone(
     clone_from_specs(directory, cloud, checkout_branch_flag=False, checkout_commit_flag=False)
 
 
-@sync_app.command(name="checkout-to-commit")
+@sync_app.command(name="checkout-to-commit", no_args_is_help=True)
 def checkout_command(
     directory: DirectoryArgument = None,
     cloud: CloudOption = None,
@@ -108,7 +108,7 @@ def checkout_command(
     clone_from_specs(directory, cloud, checkout_branch_flag=False, checkout_commit_flag=True)
 
 
-@sync_app.command(name="checkout-to-branch")
+@sync_app.command(name="checkout-to-branch", no_args_is_help=True)
 def checkout_to_branch_command(
     directory: DirectoryArgument = None,
     cloud: CloudOption = None,
@@ -119,7 +119,7 @@ def checkout_to_branch_command(
     clone_from_specs(directory, cloud, checkout_branch_flag=True, checkout_commit_flag=False)
 
 
-@app.command()
+@app.command(no_args_is_help=True)
 def analyze(
     directory: DirectoryArgument = None,
 ) -> None: