machineconfig 5.11__tar.gz → 5.13__tar.gz

{machineconfig-5.11/src/machineconfig.egg-info → machineconfig-5.13}/PKG-INFO

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

{machineconfig-5.11 → machineconfig-5.13}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "machineconfig"
-version = "5.11"
+version = "5.13"
 description = "Dotfiles management package"
 readme = "README.md"
 license = {text = "Apache 2.0"}
@@ -106,6 +106,7 @@ dev = [
     "types-sqlalchemy>=1.4.53.38",
     "types-toml>=0.10.8.20240310",
     "types-urllib3>=1.26.25.14",
+    "vt-py>=0.21.0",
 ]
 docs = [
     "pdoc>=15.0.2",

{machineconfig-5.11 → machineconfig-5.13}/src/machineconfig/jobs/python/check_installations.py

@@ -1,19 +1,6 @@
-# """CI
-# """
 
-
-# import time
 import platform
-
-# from typing import Any
-# from rich.console import Console
-# from machineconfig.utils.utils2 import pprint
-# # from rich.progress import track
 from machineconfig.utils.source_of_truth import LIBRARY_ROOT
-# from machineconfig.utils.installer import get_installed_cli_apps
-# from typing import Optional
-# from datetime import datetime
-# import csv
 
 
 APP_SUMMARY_PATH = LIBRARY_ROOT.joinpath(f"profile/records/{platform.system().lower()}/apps_summary_report.csv")

{machineconfig-5.11 → machineconfig-5.13}/src/machineconfig/profile/create.py

@@ -8,6 +8,7 @@ from rich.console import Console
 from rich.panel import Panel
 from rich.pretty import Pretty
 from rich.text import Text
+from rich.table import Table
 
 from machineconfig.utils.path_extended import PathExtended
 from machineconfig.utils.links import symlink_func, symlink_copy
@@ -20,7 +21,7 @@ import os
 import ctypes
 import subprocess
 import tomllib
-from typing import Optional, Any, TypedDict
+from typing import Optional, Any, TypedDict, Literal
 
 system = platform.system()  # Linux or Windows
 ERROR_LIST: list[Any] = []  # append to this after every exception captured.
@@ -43,10 +44,35 @@ class SymlinkMapper(TypedDict):
     contents: Optional[bool]
 
 
-def apply_mapper(choice: Optional[str] = None):
+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(choice: Optional[str], prioritize_to_this: bool):
     symlink_mapper: dict[str, dict[str, SymlinkMapper]] = tomllib.loads(LIBRARY_ROOT.joinpath("profile/mapper.toml").read_text(encoding="utf-8"))
-    prioritize_to_this = True
     exclude: list[str] = []  # "wsl_linux", "wsl_windows"
+    operation_records: list[OperationRecord] = []
 
     program_keys_raw: list[str] = list(symlink_mapper.keys())
     program_keys: list[str] = []
@@ -64,10 +90,6 @@ def apply_mapper(choice: Optional[str] = None):
             return  # terminate function.
         elif len(choice_selected) == 1 and choice_selected[0] == "all":
             choice_selected = "all"  # i.e. program_keys = program_keys
-        # overwrite = choose_from_options(msg="Overwrite existing source file?", options=["yes", "no"], default="yes") == "yes"
-        from rich.prompt import Confirm
-
-        prioritize_to_this = Confirm.ask("Overwrite existing source file?", default=True)
     else:
         choice_selected = choice
 
@@ -114,22 +136,85 @@ def apply_mapper(choice: Optional[str] = None):
         for file_key, file_map in symlink_mapper[program_key].items():
             this = PathExtended(file_map["this"])
             to_this = PathExtended(file_map["to_this"].replace("REPO_ROOT", REPO_ROOT.as_posix()).replace("LIBRARY_ROOT", LIBRARY_ROOT.as_posix()))
+            
             if "contents" in file_map:
                 try:
-                    for a_target in to_this.expanduser().search("*"):
-                        symlink_func(this=this.joinpath(a_target.name), to_this=a_target, prioritize_to_this=prioritize_to_this)
+                    targets = list(to_this.expanduser().search("*"))
+                    for a_target in targets:
+                        result = symlink_func(this=this.joinpath(a_target.name), to_this=a_target, prioritize_to_this=prioritize_to_this)
+                        operation_records.append({
+                            "program": program_key,
+                            "file_key": file_key,
+                            "source": str(this.joinpath(a_target.name)),
+                            "target": str(a_target),
+                            "operation": "contents_symlink",
+                            "action": result["action"],
+                            "details": result["details"],
+                            "status": "success"
+                        })
                 except Exception as ex:
                     console.print(f"❌ [red]Config error[/red]: {program_key} | {file_key} | missing keys 'this ==> to_this'. {ex}")
-            if "copy" in file_map:
+                    operation_records.append({
+                        "program": program_key,
+                        "file_key": file_key,
+                        "source": str(this),
+                        "target": str(to_this),
+                        "operation": "contents_symlink",
+                        "action": "error",
+                        "details": f"Failed to process contents: {str(ex)}",
+                        "status": f"error: {str(ex)}"
+                    })
+                    
+            elif "copy" in file_map:
                 try:
-                    symlink_copy(this=this, to_this=to_this, prioritize_to_this=prioritize_to_this)
+                    result = symlink_copy(this=this, to_this=to_this, prioritize_to_this=prioritize_to_this)
+                    operation_records.append({
+                        "program": program_key,
+                        "file_key": file_key,
+                        "source": str(this),
+                        "target": str(to_this),
+                        "operation": "copy",
+                        "action": result["action"],
+                        "details": result["details"],
+                        "status": "success"
+                    })
                 except Exception as ex:
                     console.print(f"❌ [red]Config error[/red]: {program_key} | {file_key} | {ex}")
+                    operation_records.append({
+                        "program": program_key,
+                        "file_key": file_key,
+                        "source": str(this),
+                        "target": str(to_this),
+                        "operation": "copy",
+                        "action": "error",
+                        "details": f"Failed to copy: {str(ex)}",
+                        "status": f"error: {str(ex)}"
+                    })
             else:
                 try:
-                    symlink_func(this=this, to_this=to_this, prioritize_to_this=prioritize_to_this)
+                    result = symlink_func(this=this, to_this=to_this, prioritize_to_this=prioritize_to_this)
+                    operation_records.append({
+                        "program": program_key,
+                        "file_key": file_key,
+                        "source": str(this),
+                        "target": str(to_this),
+                        "operation": "symlink",
+                        "action": result["action"],
+                        "details": result["details"],
+                        "status": "success"
+                    })
                 except Exception as ex:
                     console.print(f"❌ [red]Config error[/red]: {program_key} | {file_key} | missing keys 'this ==> to_this'. {ex}")
+                    operation_records.append({
+                        "program": program_key,
+                        "file_key": file_key,
+                        "source": str(this),
+                        "target": str(to_this),
+                        "operation": "symlink",
+                        "action": "error",
+                        "details": f"Failed to create symlink: {str(ex)}",
+                        "status": f"error: {str(ex)}"
+                    })
 
             if program_key == "ssh" and system == "Linux":  # permissions of ~/dotfiles/.ssh should be adjusted
                 try:
@@ -147,6 +232,35 @@ def apply_mapper(choice: Optional[str] = None):
         subprocess.run(f"chmod +x {LIBRARY_ROOT.joinpath(f'scripts/{system.lower()}')} -R", shell=True, capture_output=True, text=True)
         console.print("[green]✅ Script permissions updated[/green]")
 
+    # Display operation summary table
+    if operation_records:
+        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("Operation", style="magenta", no_wrap=True)
+        table.add_column("Action", style="red", no_wrap=True)
+        table.add_column("Details", style="white")
+        table.add_column("Status", style="red", no_wrap=True)
+        
+        for record in operation_records:
+            status_style = "green" if record["status"] == "success" else "red"
+            action_style = "green" if record["action"] != "error" else "red"
+            table.add_row(
+                record["program"],
+                record["file_key"],
+                record["source"],
+                record["target"],
+                record["operation"],
+                f"[{action_style}]{record['action']}[/{action_style}]",
+                record["details"],
+                f"[{status_style}]{record['status']}[/{status_style}]"
+            )
+        
+        console.print("\n")
+        console.print(table)
+
     if len(ERROR_LIST) > 0:
         console.print(
             Panel(
@@ -169,7 +283,7 @@ def apply_mapper(choice: Optional[str] = None):
 def main_symlinks():
     console.print("")
     console.rule("[bold blue]🔗 CREATING SYMLINKS 🔗")
-    apply_mapper(choice="all")
+    apply_mapper(choice="all", prioritize_to_this=True)
 
 
 def main_profile():

{machineconfig-5.11 → machineconfig-5.13}/src/machineconfig/scripts/python/count_lines.py

@@ -1,4 +1,3 @@
-from __future__ import annotations
 
 from typing import TYPE_CHECKING
 from git import Repo
@@ -7,14 +6,12 @@ from datetime import datetime
 
 from pathlib import Path
 from rich.progress import track
-import polars as pl
-import plotly.graph_objects as go
-import plotly.express as px
 import typer
 
 
 if TYPE_CHECKING:
     from typing import Any, Dict, List, Optional, Union
+    import polars as pl
 
 
 app = typer.Typer()
@@ -109,6 +106,10 @@ def analyze_over_time(repo_path: str = typer.Argument(..., help="Path to the git
     except Exception as e:
         print(f"❌ Error analyzing commits: {str(e)}")
         return
+
+    import polars as pl
+    import plotly.graph_objects as go
+
     df = pl.DataFrame(commit_data)
     df = df.sort("dtmExit")
     # Create interactive plotly figure with dark theme and all bells and whistles
@@ -183,6 +184,10 @@ def analyze_over_time(repo_path: str = typer.Argument(..., help="Path to the git
 
 
 def _print_python_files_by_size_impl(repo_path: str) -> "Union[pl.DataFrame, Exception]":
+    import polars as pl
+    import plotly.graph_objects as go
+    import plotly.express as px
+
     try:
         import os
         if not os.path.exists(repo_path):

machineconfig-5.13/src/machineconfig/scripts/python/count_lines_frontend.py

@@ -0,0 +1,16 @@
+
+import typer
+
+
+def analyze_repo_development(repo_path: str = typer.Argument(..., help="Path to the git repository")):
+    from machineconfig.scripts.python import count_lines
+    from pathlib import Path
+    count_lines_path = Path(count_lines.__file__).resolve().parent.joinpath("count_lines.py")
+    # --project $HOME/code/machineconfig 
+    cmd = f"""uv run --python 3.13 --with machineconfig --group plot {count_lines_path} analyze-over-time {repo_path}"""
+    from machineconfig.utils.code import run_script
+    run_script(cmd)
+
+
+if __name__ == "__main__":
+    pass

{machineconfig-5.11 → machineconfig-5.13}/src/machineconfig/scripts/python/devops.py

@@ -9,7 +9,6 @@ import typer
 
 
 app = typer.Typer(help=f"🛠️ DevOps operations @ machineconfig {__version__}", no_args_is_help=True)
-
 app.command(name="install", help="📦 Install essential packages")(installer_entry_point.main)
 app.command(name="share-terminal", help="📡 Share terminal via web browser")(share_terminal.main)
 app.add_typer(repos.app, name="repos", help="📁 Manage git repositories")

{machineconfig-5.11 → machineconfig-5.13}/src/machineconfig/scripts/python/interactive.py

@@ -186,8 +186,8 @@ Set-Service -Name sshd -StartupType 'Automatic'"""
 
     if "retrieve_repositories" in selected_options:
         console.print(Panel("📚 [bold bright_magenta]REPOSITORIES[/bold bright_magenta]\n[italic]Project code retrieval[/italic]", border_style="bright_magenta"))
-        from machineconfig.scripts.python import repos as module
-        module.main(directory=str(Path.home() / "code"), capture=True, cloud="odg1")
+        from machineconfig.scripts.python import repos
+        repos.clone(directory=str(Path.home() / "code"), cloud="odg1")
 
     if "retrieve_data" in selected_options:
         console.print(Panel("💾 [bold bright_cyan]DATA RETRIEVAL[/bold bright_cyan]\n[italic]Backup restoration[/italic]", border_style="bright_cyan"))

machineconfig-5.13/src/machineconfig/scripts/python/repos.py

@@ -0,0 +1,132 @@
+"""Repos CLI powered by Typer.
+
+# TODO use gh api user --jq '.login' to get the username and use it to clone the repos.
+in the event that username@github.com is not mentioned in the remote url.
+
+"""
+
+
+from typing import Annotated, Optional
+import typer
+
+
+
+app = typer.Typer(help="� Manage development repositories", no_args_is_help=True)
+sync_app = typer.Typer(help="� Manage repository specifications and syncing", no_args_is_help=True)
+app.add_typer(sync_app, name="sync", help="� Sync repositories using saved specs")
+
+
+DirectoryArgument = Annotated[
+    Optional[str],
+    typer.Argument(help="📁 Folder containing repos or the specs JSON file to use."),
+]
+RecursiveOption = Annotated[
+    bool,
+    typer.Option("--recursive", "-r", help="🔍 Recurse into nested repositories."),
+]
+NoSyncOption = Annotated[
+    bool,
+    typer.Option("--no-sync", help="🚫 Disable automatic uv sync after pulls."),
+]
+CloudOption = Annotated[
+    Optional[str],
+    typer.Option("--cloud", "-c", help="☁️ Upload to or download from this cloud remote."),
+]
+
+
+
+@app.command()
+def push(directory: DirectoryArgument = None,
+    recursive: RecursiveOption = False,
+    no_sync: NoSyncOption = False,
+) -> 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()
+def pull(
+    directory: DirectoryArgument = None,
+    recursive: RecursiveOption = False,
+    no_sync: NoSyncOption = False,
+) -> None:
+    """⬇️ 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()
+def commit(
+    directory: DirectoryArgument = None,
+    recursive: RecursiveOption = False,
+    no_sync: NoSyncOption = False,
+) -> None:
+    """💾 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(
+    directory: DirectoryArgument = None,
+    recursive: RecursiveOption = False,
+    no_sync: NoSyncOption = False,
+) -> None:
+    """🔄 Pull, commit, and push changes across repositories."""
+    from machineconfig.scripts.python.repos_helper import git_operations
+    git_operations(directory, pull=True, commit=True, push=True, recursive=recursive, no_sync=no_sync)
+
+
+@sync_app.command()
+def capture(
+    directory: DirectoryArgument = None,
+    cloud: CloudOption = None,
+) -> None:
+    """📝 Record repositories into a repos.json specification."""
+    from machineconfig.scripts.python.repos_helper import print_banner, resolve_directory
+    print_banner()
+    repos_root = resolve_directory(directory)
+    from machineconfig.scripts.python.repos_helper_record import main as record_repos
+    save_path = record_repos(repos_root=repos_root)
+    from machineconfig.utils.path_extended import PathExtended
+    if cloud is not None:
+        PathExtended(save_path).to_cloud(rel2home=True, cloud=cloud)
+@sync_app.command()
+def clone(
+    directory: DirectoryArgument = None,
+    cloud: CloudOption = None,
+) -> None:
+    """📥 Clone repositories described by a repos.json specification."""
+    from machineconfig.scripts.python.repos_helper import print_banner, clone_from_specs
+    print_banner()
+    clone_from_specs(directory, cloud, checkout_branch_flag=False, checkout_commit_flag=False)
+
+
+@sync_app.command(name="checkout-to-commit")
+def checkout_command(
+    directory: DirectoryArgument = None,
+    cloud: CloudOption = None,
+) -> None:
+    """🔀 Check out specific commits listed in the specification."""
+    from machineconfig.scripts.python.repos_helper import print_banner, clone_from_specs
+    print_banner()
+    clone_from_specs(directory, cloud, checkout_branch_flag=False, checkout_commit_flag=True)
+
+
+@sync_app.command(name="checkout-to-branch")
+def checkout_to_branch_command(
+    directory: DirectoryArgument = None,
+    cloud: CloudOption = None,
+) -> None:
+    """🔀 Check out to the main branch defined in the specification."""
+    from machineconfig.scripts.python.repos_helper import print_banner, clone_from_specs
+    print_banner()
+    clone_from_specs(directory, cloud, checkout_branch_flag=True, checkout_commit_flag=False)
+
+
+@app.command()
+def analyze(
+    directory: DirectoryArgument = None,
+) -> None:
+    """📊 Analyze repository development over time."""
+    from machineconfig.scripts.python.repos_helper import print_banner
+    print_banner()
+    repo_path = directory if directory is not None else "."
+    from machineconfig.scripts.python.count_lines_frontend import analyze_repo_development
+    analyze_repo_development(repo_path=repo_path)
+

machineconfig-5.13/src/machineconfig/scripts/python/repos_helper.py

@@ -0,0 +1,85 @@
+
+
+
+from typing import Optional
+from pathlib import Path
+from machineconfig.utils.source_of_truth import CONFIG_PATH, DEFAULTS_PATH
+
+import typer
+
+
+
+def print_banner() -> None:
+    typer.echo("\n" + "=" * 50)
+    typer.echo("📂 Welcome to the Repository Manager")
+    typer.echo("=" * 50 + "\n")
+
+
+
+def resolve_directory(directory: Optional[str]) -> Path:
+    if directory is None:
+        directory = Path.cwd().as_posix()
+        typer.echo(f"📁 Using directory: {directory}")
+    return Path(directory).expanduser().absolute()
+def git_operations(
+    directory: Optional[str],
+    *,
+    pull: bool,
+    commit: bool,
+    push: bool,
+    recursive: bool,
+    no_sync: bool,
+) -> None:
+    print_banner()
+    repos_root = resolve_directory(directory)
+    auto_sync = not no_sync
+    from machineconfig.scripts.python.repos_helper_action import perform_git_operations
+    from machineconfig.utils.path_extended import PathExtended
+    perform_git_operations(
+        repos_root=PathExtended(repos_root),
+        pull=pull,
+        commit=commit,
+        push=push,
+        recursive=recursive,
+        auto_sync=auto_sync,
+    )
+def resolve_spec_path(directory: Optional[str], cloud: Optional[str]) -> Path:
+    repos_root = resolve_directory(directory)
+    from machineconfig.utils.path_extended import PathExtended
+    if not repos_root.exists() or repos_root.name != "repos.json":
+        candidate = Path(CONFIG_PATH).joinpath("repos").joinpath(PathExtended(repos_root).rel2home()).joinpath("repos.json")
+        repos_root = candidate
+        if not repos_root.exists():
+            cloud_name: Optional[str]
+            if cloud is None:
+                from machineconfig.utils.io import read_ini
+                cloud_name = read_ini(DEFAULTS_PATH)["general"]["rclone_config_name"]
+                typer.echo(f"⚠️ Using default cloud: {cloud_name}")
+            else:
+                cloud_name = cloud
+            assert cloud_name is not None, (
+                f"Path {repos_root} does not exist and cloud was not passed. You can't clone without one of them."
+            )
+            from machineconfig.utils.path_extended import PathExtended
+            PathExtended(repos_root).from_cloud(cloud=cloud_name, rel2home=True)
+    assert repos_root.exists() and repos_root.name == "repos.json", (
+        f"Path {repos_root} does not exist and cloud was not passed. You can't clone without one of them."
+    )
+    return repos_root
+def clone_from_specs(
+    directory: Optional[str],
+    cloud: Optional[str],
+    *,
+    checkout_branch_flag: bool,
+    checkout_commit_flag: bool,
+) -> None:
+    print_banner()
+    typer.echo("\n📥 Cloning or checking out repositories...")
+    spec_path = resolve_spec_path(directory, cloud)
+    from machineconfig.scripts.python.repos_helper_clone import clone_repos
+    clone_repos(
+        spec_path=spec_path,
+        preferred_remote=None,
+        checkout_branch_flag=checkout_branch_flag,
+        checkout_commit_flag=checkout_commit_flag,
+    )