machineconfig 1.92__py3-none-any.whl → 1.94__py3-none-any.whl

machineconfig/jobs/python_custom_installers/gh.py

@@ -1,10 +1,9 @@
-
 """gh-cli installer
 """
 
 import platform
 from typing import Optional
-from machineconfig.utils.installer import Installer
+from machineconfig.utils.installer_utils.installer_class import Installer
 from crocodile.meta import Terminal
 
 r"""
@@ -30,22 +29,65 @@ config_dict = {
 
 
 def main(version: Optional[str]):
+    print(f"""
+{'═' * 70}
+🔱 GITHUB CLI INSTALLER | Command line tool for GitHub
+💻 Platform: {platform.system()}
+🔄 Version: {'latest' if version is None else version}
+{'═' * 70}
+""")
+    
     _ = version
     inst = Installer.from_dict(d=config_dict, name="gh")
+    print("""
+📦 INSTALLATION | Installing GitHub CLI base package...
+""")
     inst.install(version=version)
+    
+    print(f"""
+{'─' * 70}
+🤖 GITHUB COPILOT | Setting up GitHub Copilot CLI extension
+{'─' * 70}
+""")
+    
     if platform.system() == "Windows":
+        print("""
+🪟 WINDOWS SETUP | Configuring GitHub CLI for Windows...
+""")
         program = "gh extension install github/gh-copilot"
     elif platform.system() == "Linux":
+        print("""
+🐧 LINUX SETUP | Configuring GitHub CLI for Linux...
+""")
         program = """
 gh extension install github/gh-copilot
 """
     else:
-        raise NotImplementedError("unsupported platform")
+        error_msg = f"Unsupported platform: {platform.system()}"
+        print(f"""
+{'⚠️' * 20}
+❌ ERROR | {error_msg}
+{'⚠️' * 20}
+""")
+        raise NotImplementedError(error_msg)
 
     program += """
 gh auth login --with-token $HOME/dotfiles/creds/git/gh_token.txt
 """
-    Terminal().run(program, shell="default").print(desc="installing gh-copilot extension", capture=True)
+    print("""
+🔐 AUTHENTICATION | Setting up GitHub authentication with token...
+""")
+    
+    Terminal().run(program, shell="default").print(desc="Installing GitHub Copilot extension", capture=True)
+    
+    print(f"""
+{'═' * 70}
+✅ SUCCESS | GitHub CLI installation completed
+🚀 GitHub Copilot CLI extension installed
+🔑 Authentication configured with token
+{'═' * 70}
+""")
+    
     return program
 
 

machineconfig/jobs/python_custom_installers/hx.py

@@ -1,13 +1,15 @@
-
 """
 Installers do not add runtime files to the machine, hence this script.
 """
 
 from crocodile.file_management import P
-from machineconfig.utils.installer import Installer, WINDOWS_INSTALL_PATH
+from machineconfig.utils.installer_utils.installer_abc import WINDOWS_INSTALL_PATH
 from typing import Optional
 import platform
 
+from machineconfig.utils.installer_utils.installer_abc import LINUX_INSTALL_PATH
+from machineconfig.utils.installer_utils.installer_class import Installer
+
 
 config_dict = {
         "repo_url": "CUSTOM",
@@ -20,37 +22,120 @@ config_dict = {
 
 
 def main(version: Optional[str]):
+    print(f"""
+{'═' * 80}
+║ 🧬 HELIX EDITOR INSTALLER 🧬
+{'═' * 80}
+║ 💻 Platform: {platform.system()}
+║ 📦 Version:  {'latest' if version is None else version}
+{'═' * 80}
+""")
+
     config_dict_copy = config_dict.copy()
     config_dict_copy["repo_url"] = "https://github.com/helix-editor/helix"
     inst = Installer.from_dict(d=config_dict_copy, name="hx")
+
+    print("\n📥 [Step 1/5] Downloading Helix editor...")
     downloaded, _version_to_be_installed = inst.download(version=version)
+    print("   ✨ Download complete.")
+
+    print("\n🔍 [Step 2/5] Locating executable and components...")
     if platform.system() == "Windows":
         hx_file_search = downloaded.search("hx.exe", folders=False, files=True, r=True)
     else:
-        hx_file_search = downloaded.search("hx", folders=False, files=True, r=True)        
-    assert len(hx_file_search) == 1
+        hx_file_search = downloaded.search("hx", folders=False, files=True, r=True)
+
+    if not hx_file_search:
+        print(f"""
+{'═' * 80}
+║ ❌ ERROR: Could not find 'hx' executable in downloaded files.
+{'═' * 80}
+""")
+        return "Error: Executable not found"
+
+    assert len(hx_file_search) == 1, f"Expected 1 'hx' executable, found {len(hx_file_search)}"
     hx_file = hx_file_search.list[0]
     contrib = hx_file.parent / "contrib"
     runtime = contrib.parent / "runtime"
-    assert runtime.exists()
-    assert contrib.exists()
-    P.home().joinpath(".config/helix/runtime").delete(sure=True)
-    P.home().joinpath(".config/helix/contrib").delete(sure=True)
+
+    if not runtime.exists():
+        print(f"""
+{'═' * 80}
+║ ❌ ERROR: 'runtime' directory not found at expected location: {runtime}
+{'═' * 80}
+""")
+        return "Error: Runtime directory not found"
+    if not contrib.exists():
+        print(f"""
+{'═' * 80}
+║ ❌ ERROR: 'contrib' directory not found at expected location: {contrib}
+{'═' * 80}
+""")
+        return "Error: Contrib directory not found"
+    print("   ✨ Executable and components located.")
+
+
+    print("\n🗑️  [Step 3/5] Cleaning up previous installation (if any)...")
+    runtime_path = P.home().joinpath(".config/helix/runtime")
+    contrib_path = P.home().joinpath(".config/helix/contrib")
+    runtime_path.delete(sure=True, verbose=False)
+    contrib_path.delete(sure=True, verbose=False)
+    print(f"   ✨ Cleaned '{runtime_path}' and '{contrib_path}'.")
+
+
+    print("\n📦 [Step 4/5] Installing Helix components...")
+    target_config_dir = P("~/.config/helix").expanduser()
+    target_config_dir.mkdir(parents=True, exist_ok=True)
+
     if platform.system() == "Linux":
-        # hx_file.move(folder=LINUX_INSTALL_PATH)  # to be added later
-        contrib.move(folder="~/.config/helix")
-        runtime.move(folder="~/.config/helix")
+        target_bin_path = LINUX_INSTALL_PATH
+        exe_name = "hx"
+        hx_file.move(folder=target_bin_path, overwrite=True)
+        contrib.move(folder=target_config_dir, overwrite=True)
+        runtime.move(folder=target_config_dir, overwrite=True)
+        print(f"""
+{'─' * 80}
+║ ✅ SUCCESS | Helix editor installed successfully on Linux!
+{'─' * 80}
+║ 📂 Executable: {target_bin_path / exe_name}
+║ 🔧 Config:     {target_config_dir}
+{'─' * 80}
+""")
     elif platform.system() == "Windows":
-        hx_file.move(folder=WINDOWS_INSTALL_PATH)
-        contrib.move(folder="~/.config/helix")
-        runtime.move(folder="~/.config/helix")
+        target_bin_path = WINDOWS_INSTALL_PATH
+        exe_name = "hx.exe"
+        hx_file.move(folder=target_bin_path, overwrite=True)
+        contrib.move(folder=target_config_dir, overwrite=True)
+        runtime.move(folder=target_config_dir, overwrite=True)
+        print(f"""
+{'─' * 80}
+║ ✅ SUCCESS | Helix editor installed successfully on Windows!
+{'─' * 80}
+║ 📂 Executable: {target_bin_path / exe_name}
+║ 🔧 Config:     {target_config_dir}
+{'─' * 80}
+""")
     else:
-        print("Unsupported OS")
-    downloaded.delete(sure=True)
+        print(f"""
+{'═' * 80}
+║ ⚠️ WARNING | Unsupported operating system: {platform.system()}
+║           | Installation aborted.
+{'═' * 80}
+""")
+        print("\n🧹 [Step 5/5] Cleaning up temporary download files...")
+        downloaded.delete(sure=True)
+        print("   ✨ Cleanup complete.")
+        return f"Error: Unsupported OS: {platform.system()}"
 
-    if platform.system() == "Linux":
-        inst.install(version=version)  # because we can't normally move hx (without privliage) # hx_file.move(folder=LINUX_INSTALL_PATH)
+    print("\n🧹 [Step 5/5] Cleaning up temporary download files...")
+    downloaded.delete(sure=True)
+    print("   ✨ Cleanup complete.")
 
+    print(f"""
+{'═' * 80}
+║ 🎉 Installation Finished Successfully! 🎉
+{'═' * 80}
+""")
     return ""
 
 

machineconfig/jobs/python_custom_installers/scripts/linux/brave.sh

@@ -0,0 +1,52 @@
+#!/bin/bash
+#=======================================================================
+# 🦁 BRAVE BROWSER INSTALLATION SCRIPT 🦁
+#=======================================================================
+# This script installs the Brave browser on Linux systems
+# Reference: https://brave.com/linux/
+
+echo """
+#=======================================================================
+🚀 STARTING BRAVE BROWSER INSTALLATION | Installing dependencies
+#=======================================================================
+"""
+
+# Install curl if not already installed
+echo "📥 Installing curl..."
+sudo nala install curl -y
+
+echo """
+#=======================================================================
+🔑 ADDING REPOSITORY KEYS | Setting up Brave repository
+#=======================================================================
+"""
+
+# Add the Brave browser PGP key
+echo "🔐 Adding Brave browser archive keyring..."
+sudo curl -fsSLo /usr/share/keyrings/brave-browser-archive-keyring.gpg https://brave-browser-apt-release.s3.brave.com/brave-browser-archive-keyring.gpg
+
+# Add the Brave browser repository
+echo "📝 Adding Brave repository to sources list..."
+echo "deb [signed-by=/usr/share/keyrings/brave-browser-archive-keyring.gpg] https://brave-browser-apt-release.s3.brave.com/ stable main" | sudo tee /etc/apt/sources.list.d/brave-browser-release.list
+
+echo """
+#=======================================================================
+📦 INSTALLING BRAVE BROWSER | Updating and installing packages
+#=======================================================================
+"""
+
+# Update package lists
+echo "🔄 Updating package lists..."
+sudo nala update
+
+# Install Brave browser
+echo "📥 Installing Brave browser..."
+sudo nala install brave-browser -y
+
+echo """
+#=======================================================================
+✅ INSTALLATION COMPLETE | Brave browser has been installed successfully
+#=======================================================================
+"""
+echo "🦁 You can now launch Brave browser from your applications menu or by typing 'brave-browser' in terminal"
+

machineconfig/jobs/python_custom_installers/scripts/linux/docker.sh

@@ -0,0 +1,140 @@
+#!/bin/bash
+#=======================================================================
+# 🐳 DOCKER INSTALLATION SCRIPT 🐳
+#=======================================================================
+# This script installs Docker on Debian/Ubuntu-based Linux distributions
+
+#-----------------------------------------------------------------------
+# 🔍 SYSTEM DETECTION | Identify OS distribution and version
+#-----------------------------------------------------------------------
+echo """
+#=======================================================================
+🔍 DETECTING SYSTEM | Identifying OS distribution and version
+#=======================================================================
+"""
+
+get_os_type() {
+    if [ -f "/etc/debian_version" ]; then
+        if [ -f "/etc/ubuntu_version" ] || [ -f "/etc/lsb-release" ]; then
+            echo "ubuntu"
+        else
+            echo "debian"
+        fi
+    fi
+}
+
+get_ubuntu_base_version() {
+    local mint_codename=$(lsb_release -cs)
+    case "$mint_codename" in
+        "wilma")
+            echo "noble"
+            ;;
+        "virginia")
+            echo "jammy"
+            ;;
+        *)
+            echo "$mint_codename"
+            ;;
+    esac
+}
+
+get_debian_version() {
+    lsb_release -cs
+}
+
+OS_TYPE=$(get_os_type)
+if [ "$OS_TYPE" = "ubuntu" ]; then
+    DISTRO_VERSION=$(get_ubuntu_base_version)
+else
+    DISTRO_VERSION=$(get_debian_version)
+fi
+
+echo "🖥️ Detected OS: $OS_TYPE"
+echo "📋 Distribution version: $DISTRO_VERSION"
+
+#-----------------------------------------------------------------------
+# 🔑 REPOSITORY SETUP | Adding Docker's official repository
+#-----------------------------------------------------------------------
+echo """
+#=======================================================================
+🔑 REPOSITORY SETUP | Adding Docker's official repository
+#=======================================================================
+"""
+
+# Install prerequisites
+echo "📥 Installing prerequisites..."
+sudo nala update
+sudo nala install ca-certificates curl -y
+
+# Add Docker's official GPG key
+echo "🔐 Adding Docker's official GPG key..."
+sudo install -m 0755 -d /etc/apt/keyrings
+sudo curl -fsSL "https://download.docker.com/linux/$OS_TYPE/gpg" | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
+
+# Add the repository to Apt sources
+echo "📝 Adding Docker repository to sources list..."
+echo \
+  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/$OS_TYPE \
+  $DISTRO_VERSION stable" | \
+  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+
+#-----------------------------------------------------------------------
+# 📦 INSTALLATION | Installing Docker packages
+#-----------------------------------------------------------------------
+echo """
+#=======================================================================
+📦 INSTALLATION | Installing Docker packages
+#=======================================================================
+"""
+
+echo "🔄 Updating package lists..."
+sudo nala update
+echo "📥 Installing Docker packages..."
+sudo nala install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -y
+
+#-----------------------------------------------------------------------
+# 🚀 CONFIGURATION | Setting up Docker service and permissions
+#-----------------------------------------------------------------------
+echo """
+#=======================================================================
+🚀 CONFIGURATION | Setting up Docker service and permissions
+#=======================================================================
+"""
+
+echo "⚙️ Enabling Docker system service..."
+sudo systemctl enable docker || echo "⚠️ Could not enable Docker service (may be WSL or systemd not available)"
+
+echo "🧪 Testing Docker installation with hello-world..."
+docker run hello-world || echo "⚠️ Docker hello-world test failed (you may need to start the Docker daemon)"
+
+echo "👥 Adding current user to docker group..."
+sudo groupadd docker 2>/dev/null || echo "ℹ️ Docker group already exists"
+sudo usermod -aG docker $USER || echo "⚠️ Failed to add user to docker group"
+
+echo """
+#=======================================================================
+✅ INSTALLATION COMPLETE | Docker has been installed successfully
+#=======================================================================
+
+ℹ️ NOTES:
+- You may need to log out and log back in for group changes to take effect
+- Or run 'newgrp docker' to apply changes immediately
+- On WSL, you may need to run: sudo service docker start
+
+📚 TROUBLESHOOTING:
+- If 'docker run hello-world' fails with connection error:
+  For systemd systems: systemctl start dockerd
+  For WSL without systemd: sudo service docker start
+- For more information, visit: https://docs.docker.com/engine/install/linux-postinstall/
+"""
+
+# Additional notes:
+# - In older WSL, after installation, 'docker run hello-world' may fail with connection error
+#   See: https://stackoverflow.com/questions/44678725/cannot-connect-to-the-docker-daemon-at-unix-var-run-docker-sock-is-the-docker
+# 
+# - No internet in WSL docker instance: add /etc/docker/daemon.json
+#   See: https://github.com/MicrosoftDocs/WSL/issues/422
+# 
+# - For Databricks environments only:
+#   sudo nala install fuse-overlayfs
+

machineconfig/jobs/python_custom_installers/scripts/linux/docker_start.sh

@@ -0,0 +1,48 @@
+#!/bin/sh
+#=======================================================================
+# 🐳 DOCKER DAEMON INIT SCRIPT 🐳
+#=======================================================================
+# This script should be placed at /etc/init.d/docker
+# It manages Docker daemon startup/shutdown for systems without systemd
+
+### BEGIN INIT INFO
+# Provides:          docker
+# Required-Start:    $remote_fs $syslog
+# Required-Stop:     $remote_fs $syslog
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: Start daemon at boot time
+# Description:       Enable Docker service for systems without systemd
+### END INIT INFO
+
+case "$1" in
+  start)
+    echo """
+    #=======================================================================
+    🚀 STARTING | Launching Docker daemon
+    #=======================================================================
+    """
+    /usr/bin/dockerd &
+    ;;
+  stop)
+    echo """
+    #=======================================================================
+    🛑 STOPPING | Terminating Docker daemon
+    #=======================================================================
+    """
+    killall dockerd
+    ;;
+  *)
+    echo """
+    #=======================================================================
+    ❓ USAGE | Command not recognized
+    #=======================================================================
+    
+    📋 Valid commands: /etc/init.d/docker {start|stop}
+    """
+    exit 1
+    ;;
+esac
+
+exit 0
+

machineconfig/jobs/python_custom_installers/scripts/linux/edge.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+#=======================================================================
+# 🌐 MICROSOFT EDGE INSTALLATION SCRIPT 🌐
+#=======================================================================
+# This script installs Microsoft Edge browser on Linux systems
+
+echo """
+#=======================================================================
+🔑 ADDING REPOSITORY KEYS | Setting up Microsoft repository
+#=======================================================================
+"""
+
+# Download and install Microsoft's GPG key
+echo "🔐 Downloading Microsoft's GPG key..."
+curl https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > microsoft.gpg
+echo "📝 Installing Microsoft's GPG key to trusted sources..."
+sudo install -o root -g root -m 644 microsoft.gpg /etc/apt/trusted.gpg.d/
+
+# Add the Microsoft Edge repository
+echo "📝 Adding Microsoft Edge repository to sources list..."
+sudo sh -c 'echo "deb [arch=amd64] https://packages.microsoft.com/repos/edge stable main" > /etc/apt/sources.list.d/microsoft-edge-dev.list'
+
+# Clean up temporary files
+echo "🧹 Cleaning up temporary files..."
+sudo rm microsoft.gpg
+
+echo """
+#=======================================================================
+📦 INSTALLING MICROSOFT EDGE | Updating and installing packages
+#=======================================================================
+"""
+
+# Update package lists
+echo "🔄 Updating package lists..."
+sudo nala update
+
+# Install Microsoft Edge
+echo "📥 Installing Microsoft Edge..."
+sudo nala install microsoft-edge-stable
+
+echo """
+#=======================================================================
+✅ INSTALLATION COMPLETE | Microsoft Edge has been installed successfully
+#=======================================================================
+"""
+echo "🌐 You can now launch Microsoft Edge from your applications menu or by typing 'microsoft-edge' in terminal"
+

machineconfig/jobs/python_custom_installers/scripts/linux/nerdfont.sh

@@ -0,0 +1,64 @@
+#!/bin/bash
+#=======================================================================
+# 🔤 NERD FONT INSTALLATION SCRIPT 🔤
+#=======================================================================
+# This script installs CascadiaCode Nerd Font for enhanced terminal and coding experience
+
+echo """
+#=======================================================================
+📥 DOWNLOADING | Fetching CascadiaCode Nerd Font
+#=======================================================================
+"""
+
+# Navigate to Downloads directory
+echo "📂 Changing to Downloads directory..."
+cd ~/Downloads
+
+# Download the font archive
+echo "🔽 Downloading CascadiaCode Nerd Font..."
+curl -LO https://github.com/ryanoasis/nerd-fonts/releases/download/v3.2.1/CascadiaCode.tar.xz
+
+echo """
+#=======================================================================
+📦 EXTRACTING | Unpacking font archive
+#=======================================================================
+"""
+# Extract the fonts
+echo "📂 Extracting font files..."
+tar -xvf CascadiaCode.tar.xz
+
+echo """
+#=======================================================================
+🔧 INSTALLING | Setting up font files
+#=======================================================================
+"""
+# Create fonts directory if it doesn't exist
+echo "📁 Creating local fonts directory..."
+mkdir -p ~/.local/share/fonts
+
+# Move font files to the fonts directory
+echo "📋 Moving font files to fonts directory..."
+mv ./*.ttf ~/.local/share/fonts
+
+# Update the font cache
+echo "🔄 Updating font cache..."
+fc-cache -f -v
+
+echo """
+#=======================================================================
+🧹 CLEANING UP | Removing temporary files
+#=======================================================================
+"""
+# Clean up downloaded and extracted files
+echo "🧹 Removing temporary files..."
+rm -rf CascadiaCode
+rm CascadiaCode.tar.xz
+
+echo """
+#=======================================================================
+✅ INSTALLATION COMPLETE | CascadiaCode Nerd Font has been installed
+#=======================================================================
+"""
+echo "ℹ️ To verify installation, run: fc-list | grep CaskaydiaCove"
+echo "💡 USE 'CaskaydiaCove Nerd Font' in VS Code and other applications"
+echo "🔄 You may need to restart applications to see the new font"

machineconfig/jobs/python_custom_installers/scripts/linux/pgsql.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+#=======================================================================
+# 🐘 POSTGRESQL INSTALLATION SCRIPT 🐘
+#=======================================================================
+# This script installs PostgreSQL database on Ubuntu/Debian systems
+# Reference: https://www.postgresql.org/download/linux/ubuntu/
+
+echo """
+#=======================================================================
+🚀 STARTING POSTGRESQL INSTALLATION | Setting up PostgreSQL database
+#=======================================================================
+"""
+
+# Install PostgreSQL common package
+echo "📥 Installing PostgreSQL common package..."
+sudo nala install postgresql-common -y
+
+# Run the PostgreSQL repository setup script
+echo "🔧 Setting up PostgreSQL repository..."
+sudo /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh -y
+
+# Install PostgreSQL 17
+echo """
+#=======================================================================
+📦 INSTALLING POSTGRESQL | Installing PostgreSQL 17
+#=======================================================================
+"""
+sudo nala install postgresql-17 -y
+# Alternative: sudo nala install postgresql -y
+
+echo """
+#=======================================================================
+✅ INSTALLATION COMPLETE | PostgreSQL has been installed successfully
+#=======================================================================
+"""
+echo "ℹ️ PostgreSQL service should be running automatically"
+echo "💡 Connect to default 'postgres' database with: sudo -u postgres psql"
+echo "🔄 To check service status: sudo systemctl status postgresql"
+
+# REMOVAL INSTRUCTIONS:
+echo """
+#-----------------------------------------------------------------------
+📝 NOTES | For future reference
+#-----------------------------------------------------------------------
+To remove PostgreSQL completely:
+sudo apt-get --purge remove postgresql postgresql-*
+"""
+
+# Alternative installation method (commented out):
+# sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $ubuntu_version-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
+# curl -fsSL https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/postgresql.gpg
+# sudo nala update
+