machineconfig 7.50__py3-none-any.whl → 8.12__py3-none-any.whl

machineconfig/utils/ssh_utils/wsl.py

@@ -0,0 +1,210 @@
+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 _infer_windows_home_from_permissions() -> 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
+    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:
+        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() -> Path:
+    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()
+
+
+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) -> None:
+    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
+        link_path.unlink()
+    elif link_path.exists():
+        raise FileExistsError(link_path)
+    link_path.symlink_to(target_path, target_is_directory=True)
+
+
+def copy_when_inside_wsl(source: Path | str, target: Path | str, overwrite: bool) -> None:
+    _ensure_wsl_environment()
+    source_relative = _ensure_relative_path(source)
+    target_relative = _ensure_relative_path(target)
+    source_path = Path.home() / source_relative
+    target_path = _resolve_windows_home_from_wsl() / target_relative
+    if not source_path.exists():
+        raise FileNotFoundError(source_path)
+    if target_path.exists():
+        if not overwrite:
+            raise FileExistsError(target_path)
+        _remove_path(target_path)
+    target_path.parent.mkdir(parents=True, exist_ok=True)
+    if source_path.is_dir():
+        shutil.copytree(source_path, target_path, dirs_exist_ok=False)
+        return
+    print(f"Copying {source_path} to {target_path}")
+    shutil.copy2(source_path, target_path)
+
+
+def copy_when_inside_windows(source: Path | str, target: Path | str, overwrite: bool) -> None:
+    _ensure_windows_environment()
+    source_relative = _ensure_relative_path(source)
+    target_relative = _ensure_relative_path(target)
+    source_path = Path.home() / source_relative
+    target_path = _resolve_wsl_home_on_windows() / target_relative
+    if not source_path.exists():
+        raise FileNotFoundError(source_path)
+    if target_path.exists():
+        if not overwrite:
+            raise FileExistsError(target_path)
+        _remove_path(target_path)
+    _run_windows_copy_command(source_path, target_path)
+
+
+def link_wsl_and_windows() -> None:
+    system = platform.system()
+    if system == "Darwin":
+        raise RuntimeError("link_wsl_and_windows is not designed for macOS")
+    try:
+        _ensure_wsl_environment()
+    except RuntimeError:
+        try:
+            _ensure_windows_environment()
+        except RuntimeError as exc:
+            raise RuntimeError("link_wsl_and_windows must run inside Windows or WSL") from exc
+        target_path = _resolve_wsl_home_on_windows()
+        link_path = Path.home() / "wsl"
+        _ensure_symlink(link_path, target_path)
+        return
+    target_path = _resolve_windows_home_from_wsl()
+    link_path = Path.home() / "win"
+    _ensure_symlink(link_path, target_path)
+
+
+if __name__ == "__main__":
+    copy_when_inside_wsl(Path("projects/source.txt"), Path("windows_projects/source.txt"), True)
+    copy_when_inside_windows(Path("documents/example.txt"), Path("linux_documents/example.txt"), True)

machineconfig/utils/terminal.py

@@ -4,6 +4,7 @@ from typing import Any, BinaryIO, Optional, Union
 from typing import Literal, TypeAlias
 from dataclasses import dataclass
 
+
 SHELLS: TypeAlias = Literal["default", "cmd", "powershell", "pwsh", "bash"]  # pwsh.exe is PowerShell (community) and powershell.exe is Windows Powershell (msft)
 CONSOLE: TypeAlias = Literal["wt", "cmd"]
 MACHINE: TypeAlias = Literal["Windows", "Linux", "Darwin"]

machineconfig/utils/upgrade_packages.py

@@ -138,6 +138,10 @@ def upgrade_machine_config_version() -> None:
     # Find all Python files and replace version constraints
     py_files: list[Path] = list(current_dir.glob("**/*.py")) + list(current_dir.glob("**/*.sh")) + list(current_dir.glob("**/*.ps1"))
     
+    # Also include Dockerfile files
+    dockerfile_files: list[Path] = [f for f in current_dir.glob("**/Dockerfile*") if f.is_file()]
+    py_files.extend(dockerfile_files)
+    
     files_updated: int = 0
     for file_path in py_files:
         try:
@@ -164,8 +168,9 @@ def upgrade_machine_config_version() -> None:
         except (UnicodeDecodeError, PermissionError):
             # Skip files that can't be read as text
             pass
-    
     print(f"Updated {files_updated} files with version constraint")
+    from machineconfig.utils.code import exit_then_run_shell_script
+    exit_then_run_shell_script(f"cd {current_dir}; uv sync")
 
 
 if __name__ == "__main__":

machineconfig/utils/ve.py

@@ -1,18 +1,20 @@
-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: Path) -> tuple[Optional[str], Optional[str]]:
+def get_ve_path_and_ipython_profile(init_path: "Path") -> tuple[Optional[str], Optional[str]]:
     """Works with .ve.ini .venv and .ve_path"""
     ve_path: Optional[str] = None
     ipy_profile: Optional[str] = None
     tmp = init_path
+
+    from machineconfig.utils.io import read_ini
+
     for _ in init_path.parents:
         if tmp.joinpath(".ve.ini").exists():
             ini = read_ini(tmp.joinpath(".ve.ini"))
             if ve_path is None:
+                
                 try:
                     ve_path = ini["specs"]["ve_path"]
                 except KeyError:
@@ -39,6 +41,8 @@ def get_ve_path_and_ipython_profile(init_path: Path) -> tuple[Optional[str], Opt
 
 
 def get_ve_activate_line(ve_root: str):
+    import platform
+    from pathlib import Path
     if platform.system() == "Windows":
         q = Path(ve_root).expanduser().relative_to(Path.home()).as_posix()
         activate_ve_line = f". $HOME/{q}/Scripts/activate.ps1"
@@ -47,3 +51,7 @@ def get_ve_activate_line(ve_root: str):
     else:
         raise NotImplementedError(f"Platform {platform.system()} not supported.")
     return activate_ve_line
+
+
+if __name__ == "__main__":
+    from pathlib import Path

machineconfig-8.12.dist-info/METADATA

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: machineconfig
+Version: 8.12
+Summary: Dotfiles management package
+Author-email: Alex Al-Saffar <programmer@usa.com>
+License: Apache 2.0
+Project-URL: Homepage, https://github.com/thisismygitrepo/machineconfig
+Project-URL: Bug Tracker, https://github.com/thisismygitrepo/machineconfig/issues
+Classifier: Programming Language :: Python :: 3
+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: joblib>=1.5.2
+Requires-Dist: paramiko>=3.5.1
+Requires-Dist: randomname>=0.2.1
+Requires-Dist: requests>=2.32.5
+Requires-Dist: rich>=14.0.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
+Provides-Extra: windows
+Requires-Dist: pywin32; extra == "windows"
+Provides-Extra: plot
+Requires-Dist: sqlalchemy>=2.0.43; extra == "plot"
+Requires-Dist: ipykernel>=6.30.1; extra == "plot"
+Requires-Dist: ipython>=9.5.0; extra == "plot"
+Requires-Dist: jupyterlab>=4.4.9; extra == "plot"
+Requires-Dist: kaleido>=1.1.0; extra == "plot"
+Requires-Dist: matplotlib>=3.10.6; extra == "plot"
+Requires-Dist: nbformat>=5.10.4; extra == "plot"
+Requires-Dist: numpy>=2.3.3; extra == "plot"
+Requires-Dist: plotly>=6.3.0; extra == "plot"
+Requires-Dist: polars>=1.33.1; extra == "plot"
+Requires-Dist: python-magic>=0.4.27; extra == "plot"
+
+
+<p align="center">
+
+<a href="https://github.com/thisismygitrepo/machineconfig/commits">
+<img src="https://img.shields.io/github/commit-activity/m/thisismygitrepo/machineconfig" />
+</a>
+
+</p>
+
+
+# 🧠 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.
+
+
+## 💡 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?
+* A bunch of CLI tools.
+* [Optional] A bunch of softwares (GUIs for desktop environment)
+* [Public] A bunch of configuration files for your tools.
+* [Private] A bunch of secrets, passowords, tokens, credentials etc, etc.
+* Data (Both highly sensitive and encrypted less serious unencrypted data)
+* Code (your repositories).
+
+Wouldn't be nice if you can set it all up in 2 minutes? This is a hackable tool to get it done.
+
+Consider this concrete scenario: When setting up a new machine, VM, or Docker container, you often face dependency chains like this:
+
+```mermaid
+flowchart TD
+    A["Need to setup my [dev] environment"] --> B["need my tool x, e.g.: yadm"]
+    B --> C["Requires git"]
+    C --> D["Requires package manager, e.g. brew"]
+    D --> E["Requires curl"]
+    E --> F["Requires network setup / system update"]
+    F --> G["Requires system configuration access"]
+    G --> H["Finally ready to start setup the tool x."]
+```
+
+Machineconfig builds on shoulder of giants. A suite of best-in-class stack of projects on github are used, the most starred, active and written in Rust tools are used when possible. The goal is to provide a seamless experience that abstracts away the complexity of setting up and maintaining your digital environment. The goal of machineconfig is to replicate your setup, config, code, data and secrets on any machine, any os, in 5 minutes, using minimal user input. Then, from that point, machineconfig will help you maintain, update, backup and sync your digital life across all your devices, automatically.
+
+
+## ⚙️ Functional Overview
+
+| Category               | Comparable Tools                              | Description                                               |
+|------------------------|----------------------------------------------|-----------------------------------------------------------|
+| **Package Manager**     | `winget`, `apt`, `brew`, `nix`               | Installs and manages software packages across systems.    |
+| **Configuration Manager** | `Ansible`, `Chef`, `Puppet`                | Configures and maintains system‐level preferences.        |
+| **Automation Tool**     | `Airflow`, `Prefect`, `Dagster`, `Celery`    | Automates repetitive tasks, pipelines, orchestration.     |
+| **Dotfiles Manager**    | `chezmoi`, `yadm`, `rcm`, `GNU Stow`        | Synchronises dotfiles & personal configs across systems.  |
+| **Data Solution**       | `rclone`, `rsync`                            | Handles backups, mirroring and secure file sync.          |
+| **Code Manager**        | `strong‐box`, `Vault`                        | Manages and protects code snippets, secrets and creds.    |
+
+---
+
+
+# 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
+# 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)
+```
+
+
+# Author
+Alex Al-Saffar. [email](mailto:programmer@usa.com)
+
+# Contributor
+Ruby Chan. [email](mailto:ruby.chan@sa.gov.au)
+
+
+[![Alex's github activity graph](https://github-readme-activity-graph.vercel.app/graph?username=thisismygitrepo)](https://github.com/ashutosh00710/github-readme-activity-graph)
+