machineconfig 8.14__py3-none-any.whl → 8.45__py3-none-any.whl

machineconfig/utils/ssh_utils/wsl_helper.py

@@ -0,0 +1,217 @@
+import os
+import platform
+import stat
+import shutil
+import subprocess
+from pathlib import Path, PureWindowsPath
+
+
+def ensure_relative_path(requested: Path | str) -> Path:
+    path = Path(requested)
+    if path.is_absolute():
+        raise ValueError("paths must be relative to the home directory")
+    if any(part == ".." for part in path.parts):
+        raise ValueError("paths must stay within the home directory")
+    return path
+
+
+def remove_path(path: Path) -> None:
+    if path.is_symlink() or path.is_file():
+        path.unlink()
+        return
+    shutil.rmtree(path)
+
+
+def ensure_wsl_environment() -> None:
+    if os.environ.get("WSL_DISTRO_NAME"):
+        return
+    if "microsoft" in platform.release().lower():
+        return
+    raise RuntimeError("copy_when_inside_wsl must run inside WSL")
+
+
+def ensure_windows_environment() -> None:
+    if os.name != "nt":
+        raise RuntimeError("copy_when_inside_windows must run inside Windows")
+    if os.environ.get("WSL_DISTRO_NAME"):
+        raise RuntimeError("copy_when_inside_windows must run inside Windows")
+
+
+def ensure_linux_environment() -> None:
+    if platform.system() != "Linux":
+        raise RuntimeError("change_ssh_port requires Linux environment")
+
+
+def infer_windows_home_from_permissions(windows_username: str | None) -> Path:
+    base_dir = Path("/mnt/c/Users")
+    try:
+        entries = list(base_dir.iterdir())
+    except FileNotFoundError as exc:
+        raise RuntimeError("unable to find /mnt/c/Users") from exc
+    if windows_username:
+        candidate = base_dir / windows_username
+        if candidate.is_dir():
+            return candidate
+        raise RuntimeError(f"specified Windows user directory not found: {candidate}")
+    candidates: list[Path] = []
+    for entry in entries:
+        if not entry.is_dir():
+            continue
+        if entry.name.lower() == "public" or entry.name.lower() == "all users":
+            continue
+        try:
+            mode = stat.S_IMODE(entry.stat().st_mode)
+        except OSError:
+            continue
+        if mode == 0o777:
+            candidates.append(entry)
+    if len(candidates) != 1:
+        wsl_user = os.environ.get("USER") or os.environ.get("LOGNAME")
+        if wsl_user:
+            for candidate in candidates:
+                if candidate.name == wsl_user:
+                    return candidate
+        non_default = [c for c in candidates if c.name.lower() not in ("default", "default user")]
+        if len(non_default) == 1:
+            return non_default[0]
+        options = ", ".join(sorted(candidate.name for candidate in candidates)) or "none"
+        raise RuntimeError(f"unable to infer Windows home directory (candidates: {options})")
+    return candidates[0]
+
+
+def resolve_windows_home_from_wsl(windows_username: str | None) -> Path:
+    if windows_username:
+        return infer_windows_home_from_permissions(windows_username)
+    user_profile = os.environ.get("USERPROFILE")
+    if user_profile:
+        windows_path = PureWindowsPath(user_profile)
+        drive = windows_path.drive
+        if drive:
+            drive_letter = drive.rstrip(":").lower()
+            tail = Path(*windows_path.parts[1:])
+            candidate = Path("/mnt") / drive_letter / tail
+            if candidate.exists():
+                return candidate
+    return infer_windows_home_from_permissions(windows_username)
+
+
+def decode_wsl_output(raw_bytes: bytes) -> str:
+    try:
+        return raw_bytes.decode("utf-16-le")
+    except UnicodeDecodeError:
+        return raw_bytes.decode()
+
+
+def get_single_wsl_distribution() -> str:
+    process = subprocess.run(["wsl.exe", "-l"], capture_output=True, text=False, check=True)
+    stdout = decode_wsl_output(process.stdout).replace("\ufeff", "")
+    distributions: list[str] = []
+    for raw_line in stdout.splitlines():
+        line = raw_line.strip()
+        if not line or line.lower().startswith("windows subsystem for linux"):
+            continue
+        normalized = line.lstrip("* ").replace("(Default)", "").strip()
+        if normalized:
+            distributions.append(normalized)
+    if len(distributions) != 1:
+        raise RuntimeError("unable to pick a single WSL distribution")
+    return distributions[0]
+
+
+def resolve_wsl_home_on_windows() -> Path:
+    distribution = get_single_wsl_distribution()
+    home_root = Path(rf"\\wsl$\{distribution}\home")
+    try:
+        entries = list(home_root.iterdir())
+    except FileNotFoundError as exc:
+        raise RuntimeError(f"unable to locate WSL home directories for {distribution}") from exc
+    except OSError as exc:
+        raise RuntimeError(f"unable to inspect WSL home directories for {distribution}") from exc
+    user_dirs = [entry for entry in entries if entry.is_dir()]
+    if len(user_dirs) != 1:
+        options = ", ".join(sorted(entry.name for entry in user_dirs)) or "none"
+        raise RuntimeError(f"unable to infer WSL user directory (candidates: {options})")
+    return user_dirs[0]
+
+
+def quote_for_powershell(path: Path) -> str:
+    return "'" + str(path).replace("'", "''") + "'"
+
+
+def run_windows_copy_command(source_path: Path, target_path: Path) -> None:
+    source_is_dir = source_path.is_dir()
+    parent_literal = quote_for_powershell(target_path.parent)
+    source_literal = quote_for_powershell(source_path)
+    target_literal = quote_for_powershell(target_path)
+    script = (
+        "$ErrorActionPreference = 'Stop'; "
+        f"New-Item -ItemType Directory -Path {parent_literal} -Force | Out-Null; "
+        f"Copy-Item -LiteralPath {source_literal} -Destination {target_literal}"
+        f"{' -Recurse' if source_is_dir else ''} -Force"
+    )
+    print(f"Copying {source_path} to {target_path}")
+    subprocess.run(["powershell.exe", "-NoLogo", "-NoProfile", "-Command", script], check=True)
+
+
+def ensure_symlink(link_path: Path, target_path: Path) -> bool:
+    if not target_path.exists():
+        raise FileNotFoundError(target_path)
+    if link_path.is_symlink():
+        existing_target = Path(os.path.realpath(link_path))
+        desired_target = Path(os.path.realpath(target_path))
+        if os.path.normcase(str(existing_target)) == os.path.normcase(str(desired_target)):
+            return False
+        link_path.unlink()
+    elif link_path.exists():
+        raise FileExistsError(link_path)
+    link_path.symlink_to(target_path, target_is_directory=True)
+    return True
+
+
+def parse_port_spec(port_spec: str) -> list[int]:
+    ports: list[int] = []
+    for part in port_spec.split(","):
+        part = part.strip()
+        if not part:
+            continue
+        if "-" in part:
+            range_parts = part.split("-", maxsplit=1)
+            start = int(range_parts[0].strip())
+            end = int(range_parts[1].strip())
+            if start > end:
+                raise ValueError(f"Invalid port range: {part} (start > end)")
+            ports.extend(range(start, end + 1))
+        else:
+            ports.append(int(part))
+    return ports
+
+
+def normalize_port_spec_for_firewall(port_spec: str) -> tuple[str, str]:
+    """Validates and normalizes port spec for New-NetFirewallRule -LocalPort parameter.
+    Returns (normalized_spec, human_readable_description).
+    New-NetFirewallRule natively supports ranges (e.g. '5000-5020') and comma-separated values.
+    """
+    parts: list[str] = []
+    for raw_part in port_spec.split(","):
+        part = raw_part.strip()
+        if not part:
+            continue
+        if "-" in part:
+            range_parts = part.split("-", maxsplit=1)
+            start = int(range_parts[0].strip())
+            end = int(range_parts[1].strip())
+            if start < 1 or start > 65535 or end < 1 or end > 65535:
+                raise ValueError(f"Port numbers must be between 1 and 65535: {part}")
+            if start > end:
+                raise ValueError(f"Invalid port range: {part} (start > end)")
+            parts.append(f"{start}-{end}")
+        else:
+            port = int(part)
+            if port < 1 or port > 65535:
+                raise ValueError(f"Invalid port number: {port}")
+            parts.append(str(port))
+    if not parts:
+        raise ValueError("No valid ports provided")
+    normalized = ",".join(parts)
+    description = normalized.replace(",", ", ")
+    return normalized, description

machineconfig/utils/upgrade_packages.py

@@ -33,21 +33,21 @@ def generate_uv_add_commands(pyproject_path: Path, output_path: Path) -> None:
     if "project" in pyproject_data and "dependencies" in pyproject_data["project"]:
         main_deps: list[str] = pyproject_data["project"]["dependencies"]
         if main_deps:
-            package_names: list[str] = [extract_package_name(dep) for dep in main_deps]
+            package_names: list[str] = [f"'{extract_package_name(dep)}'" for dep in main_deps]
             commands.append(f"uv add --no-cache {' '.join(package_names)}")
 
     if "project" in pyproject_data and "optional-dependencies" in pyproject_data["project"]:
         optional_deps: dict[str, list[str]] = pyproject_data["project"]["optional-dependencies"]
         for group_name, deps in optional_deps.items():
             if deps:
-                package_names = [extract_package_name(dep) for dep in deps]
+                package_names = [f"'{extract_package_name(dep)}'" for dep in deps]
                 commands.append(f"uv add --no-cache --group {group_name} {' '.join(package_names)}")
 
     if "dependency-groups" in pyproject_data:
         dep_groups: dict[str, list[str]] = pyproject_data["dependency-groups"]
         for group_name, deps in dep_groups.items():
             if deps:
-                package_names = [extract_package_name(dep) for dep in deps]
+                package_names = [f"'{extract_package_name(dep)}'" for dep in deps]
                 if group_name == "dev":
                     commands.append(f"uv add --no-cache --dev {' '.join(package_names)}")
                 else:
@@ -78,12 +78,8 @@ def extract_package_name(dependency_spec: str) -> str:
         "rich>=14.0.0" -> "rich"
         "requests>=2.32.5" -> "requests"
         "pywin32" -> "pywin32"
-        "package[extra]>=1.0" -> "package"
+        "package[extra]>=1.0" -> "package[extra]"
     """
-    # Handle extras like "package[extra]>=1.0" first
-    if "[" in dependency_spec:
-        dependency_spec = dependency_spec.split("[")[0].strip()
-
     # Split on common version operators and take the first part
     for operator in [">=", "<=", "==", "!=", ">", "<", "~=", "===", "@"]:
         if operator in dependency_spec:

{machineconfig-8.14.dist-info → machineconfig-8.45.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: machineconfig
-Version: 8.14
+Version: 8.45
 Summary: Dotfiles management package
 Author-email: Alex Al-Saffar <programmer@usa.com>
 License: Apache 2.0
@@ -11,20 +11,20 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown
-Requires-Dist: cryptography>=44.0.2
-Requires-Dist: fire>=0.7.0
+Requires-Dist: cryptography>=46.0.3
+Requires-Dist: fire>=0.7.1
+Requires-Dist: gitpython>=3.1.45
 Requires-Dist: joblib>=1.5.2
-Requires-Dist: paramiko>=3.5.1
+Requires-Dist: paramiko>=4.0.0
+Requires-Dist: psutil>=7.1.3
+Requires-Dist: questionary>=2.1.1
 Requires-Dist: randomname>=0.2.1
+Requires-Dist: rclone-python>=0.1.23
 Requires-Dist: requests>=2.32.5
-Requires-Dist: rich>=14.0.0
+Requires-Dist: rich>=14.2.0
 Requires-Dist: tenacity>=9.1.2
-Requires-Dist: psutil>=7.0.0
-Requires-Dist: gitpython>=3.1.44
-Requires-Dist: rclone-python>=0.1.23
-Requires-Dist: questionary>=2.1.1
-Requires-Dist: typer-slim>=0.19.2
-Requires-Dist: typer>=0.19.2
+Requires-Dist: typer==0.20.0
+Requires-Dist: typer-slim==0.20.0
 Provides-Extra: windows
 Requires-Dist: pywin32; extra == "windows"
 Provides-Extra: plot
@@ -50,14 +50,15 @@ Requires-Dist: python-magic>=0.4.27; extra == "plot"
 </p>
 
 
-# 🧠 Welcome to **Machineconfig**
+# 🗜 Welcome to **Machineconfig**
 
-**Machineconfig** is a cli-based cross-platform **Stack Manager** — It is a swiss-army knife; a *Package Manager*, *Configuration Manager*, *Automation Tool*, *Dotfiles Manager*, *Data Solution*, and *Code Manager*, among other functionalities covered, all rolled into one seamless experience, that is consistent across different platforms.
+Your stack is awesome, but you need a stack manager, to have a tight grip over it, put it together and maintain it.
+Entering,  **Machineconfig**, a cli-based cross-platform **Stack Manager** — It is a swiss-army knife; a *Package Manager*, *Configuration Manager*, *Automation Tool*, *Dotfiles Manager*, *Data Solution*, and *Code Manager*, among other functionalities covered, all rolled into one seamless experience, that is consistent across different platforms.
 
 
-## 💡 Motivation
-Your stack is awesome, but you need stack a manager for it, to put it together and maintain it.
-What is your stack? Say you have a new computer/ VM, how to set it?
+## Workflow:
+What is your stack? Say you have a new computer/ VM, how do you go about setting it up with your stack?
+Surely, you have:
 * A bunch of CLI tools.
 * [Optional] A bunch of softwares (GUIs for desktop environment)
 * [Public] A bunch of configuration files for your tools.
@@ -100,22 +101,28 @@ Machineconfig builds on shoulder of giants. A suite of best-in-class stack of pr
 # Install On Windows:
 
 ```powershell
-# install tool the tool only:
 powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"  # Skip if UV is already installed
 uv tool install --upgrade --python 3.14 machineconfig
-# interactive install of machineconfig and following on to run it and make basic machine configuration (RECOMMENDED):
-iex (iwr bit.ly/cfgwindows).Content  # Or, if UV is installed: iex (uvx machineconfig define)
-# Quick install and configure (optionals are accepted by default):
-iex (iwr bit.ly/cfgwq).Content
 ```
 
 
 # Install On Linux and MacOS
 
 ```bash
-# install the tool only:
 curl -LsSf https://astral.sh/uv/install.sh | sh  # Skip if UV is already installed
 uv tool install --upgrade --python 3.14 machineconfig
+```
+
+
+# Quickies ...
+```powershell
+# interactive install of machineconfig and following on to run it and make basic machine configuration (RECOMMENDED):
+irm bit.ly/cfgwindows | iex  # Or, if UV is installed: iex (uvx machineconfig define)
+# Quick install and configure (optionals are accepted by default):
+irm bit.ly/cfgwq | iex
+```
+
+```bash
 # interactive install of machineconfig and following on to run it and make basic machine configuration (RECOMMENDED):
 . <(curl -L bit.ly/cfglinux) # Or, if UV is installed: . <(uvx machineconfig define)
 ```