Add concise, meaningful comments explaining what and how

- Added sparse comments to Desktop-Linux-Tools.py explaining error handling, installation methods, and key logic
- Added comments to Debian-CLI-Tool_Installer.py clarifying system checks, package verification, and binary installation
- Comments focus on why decisions were made and how operations work

Author: Stew Alexander

Debian-CLI-Tool_Installer.py

@@ -20,7 +20,7 @@
 
 file_pass = 'a'
 
-#Check if the system is debian, else halt program
+# Verify Debian-based system via apt-get presence
 is_debian = which("apt-get")
 
 if is_debian:
@@ -61,7 +61,7 @@
 
 
 
-#Check if these programs exist [chkservice,htop,nnn,ncdu,network-manager,ne,hping3,nmap,lynis,apt-show-versions,vim,fish,tig,bmon,dnsutils,most], if not install them
+# Check each program in PATH; install missing ones via apt
 def check_programs():
     programs = ['chkservice','htop','nnn','ncdu','network-manager','ne','hping3','nmap','lynis','apt-show-versions','vim','fish','tig','bmon','dnsutils','most','curl']
     os.system('sudo apt update')
@@ -73,7 +73,7 @@ def check_programs():
             print("- \"" + program + '\" is installed')
 
 
-# Check if program in list programs appears to be available in apt, if so download it
+# Verify package exists in apt cache before installing
 def install_program(program):
     try:
         output = subprocess.run(["apt-cache", "search",program], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
@@ -86,21 +86,19 @@ def install_program(program):
         print(f"Error: {e}")
 
 
-#Check if eget is installed, if not install eget
+# Install eget if missing; downloads to current dir, then moves to /usr/bin
 def eget_installer ():
-#check if eget exists as a program
     eget_exists = os.path.exists('/usr/bin/eget')
     if not eget_exists:
        print("Eget does not exist, installing",'\n') 
-       #install eget
+       # Pipe curl output directly to sh for installation
        os.system("curl https://zyedidia.github.io/eget.sh | sh")
-       #move eget to /usr/bin
        os.system("sudo mv eget /usr/bin/eget")
     else:
         print("- \"eget\" is is installed",'\n')
         pass
 
-#Install eget programs from github source
+# Download binaries from GitHub releases using eget
 def eget_install():
     if eget_program == 'lsd':
         os.system("eget Peltoche/lsd")
@@ -112,8 +110,7 @@ def eget_install():
         print('Program not found\n')
 
 
-#Copies the file downloaded via eget to the /usr/bin/
-
+# Move eget-downloaded binaries from current dir to PATH
 def eget_copy():
     for eget_program in eget_programs:
         if os.path.exists(eget_program):

Desktop-Linux-Tools.py

@@ -82,13 +82,15 @@ def run_command(cmd: List[str], check: bool = False, capture_output: bool = Fals
                 timeout=timeout
             )
         except subprocess.TimeoutExpired:
+            # Return CompletedProcess with timeout exit code (124) to avoid crashes
             print(f"Command timed out after {timeout}s: {' '.join(cmd)}")
-            return subprocess.CompletedProcess(cmd, 124)  # 124 is timeout exit code
+            return subprocess.CompletedProcess(cmd, 124)
         except subprocess.CalledProcessError as e:
             print(f"Error running command: {' '.join(cmd)}")
             print(f"Error: {e}")
             return e
         except FileNotFoundError:
+            # Command missing from PATH - return error code without crashing
             print(f"Command not found: {cmd[0]}")
             return subprocess.CompletedProcess(cmd, 1)
 
@@ -138,7 +140,7 @@ def install_via_eget(repo: str, binary_name: str) -> bool:
         )
 
         if result.returncode == 0 and os.path.exists(binary_name):
-            # Move to /usr/local/bin (better than /usr/bin for user-installed tools)
+            # eget downloads to current dir; move to PATH for system-wide access
             move_cmd = ["sudo", "mv", binary_name, "/usr/local/bin/"]
             move_result = Installer.run_command(move_cmd)
             return move_result.returncode == 0
@@ -148,10 +150,11 @@ def install_via_eget(repo: str, binary_name: str) -> bool:
     def install_eget() -> bool:
         """Install eget if not present."""
         print("Installing eget...")
+        # Timeout flags prevent hanging on slow networks; pipe directly to sh for install
         result = Installer.run_command(
             ["sh", "-c", "curl --connect-timeout 10 --max-time 30 https://zyedidia.github.io/eget.sh | sh"],
             capture_output=True,
-            timeout=60  # Longer timeout for network operations
+            timeout=60
         )
 
         if result.returncode == 0 and os.path.exists("eget"):
@@ -173,6 +176,7 @@ def install_croc() -> bool:
     @staticmethod
     def check_apt_available(package: str) -> bool:
         """Check if package is available in apt repositories."""
+        # Regex anchors (^$) ensure exact match, not substring
         result = Installer.run_command(
             ["apt-cache", "search", "--names-only", "^" + package + "$"],
             capture_output=True
@@ -413,6 +417,7 @@ def get_user_consent() -> bool:
     print("  • Skip tools that are already installed")
     print("\n" + "="*70)
 
+    # Limit retries to prevent infinite loops on invalid input
     max_attempts = 5
     attempts = 0
 
@@ -431,6 +436,7 @@ def get_user_consent() -> bool:
                     print("Maximum attempts reached. Defaulting to 'no'.")
                     return False
         except (EOFError, KeyboardInterrupt):
+            # Handle Ctrl+C and EOF gracefully without crashing
             print("\n\nInterrupted by user. Exiting.")
             return False
 
@@ -480,6 +486,7 @@ def main():
         print(f"\n[{category}]")
         print("-" * 70)
 
+        # Sort alphabetically for consistent output
         for tool in sorted(tools, key=lambda t: t.name):
             if ToolManager.check_tool_installed(tool):
                 print(f"✓ {tool.name:30} - Already installed")