projectdevsetup 1.0.0__py3-none-any.whl

projectdevsetup/path_manager.py

@@ -0,0 +1,149 @@
+"""
+@project  projectdevsetup
+@org      Zenith Open Source Projects
+@license  MIT License
+"""
+
+import os
+import platform
+import subprocess
+from pathlib import Path
+from projectdevsetup.utils.logger import success, warning, info, error
+
+
+def add_to_path(new_path: str, tool_name: str):
+    """
+    Add a directory to PATH permanently on all 3 OS.
+    Falls back to showing manual instructions if automatic fails.
+    """
+    os_name = platform.system().lower()
+
+    if os_name == "windows":
+        _add_to_path_windows(new_path, tool_name)
+    elif os_name in ("linux", "darwin"):
+        _add_to_path_unix(new_path, tool_name)
+    else:
+        _show_manual_path_instructions(new_path, tool_name)
+
+
+def _add_to_path_windows(new_path: str, tool_name: str):
+    """Add to PATH permanently on Windows via registry."""
+    try:
+        import winreg
+
+        key = winreg.OpenKey(
+            winreg.HKEY_LOCAL_MACHINE,
+            r"SYSTEM\CurrentControlSet\Control\Session Manager\Environment",
+            0,
+            winreg.KEY_ALL_ACCESS,
+        )
+        current_path, _ = winreg.QueryValueEx(key, "Path")
+        if new_path.lower() not in current_path.lower():
+            new_value = current_path + ";" + new_path
+            winreg.SetValueEx(key, "Path", 0, winreg.REG_EXPAND_SZ, new_value)
+            winreg.CloseKey(key)
+            success(
+                f"{tool_name} added to PATH. "
+                "Please restart your terminal for this to take effect."
+            )
+        else:
+            success(f"{tool_name} is already in PATH.")
+    except PermissionError:
+        _show_manual_path_instructions_windows(new_path, tool_name)
+    except ImportError:
+        _show_manual_path_instructions_windows(new_path, tool_name)
+    except Exception:
+        _show_manual_path_instructions_windows(new_path, tool_name)
+
+
+def _add_to_path_unix(new_path: str, tool_name: str):
+    """Add to PATH permanently on Linux/Mac via shell profile."""
+    home = Path.home()
+    shell = os.environ.get("SHELL", "")
+
+    if "zsh" in shell:
+        profiles = [home / ".zshrc", home / ".zprofile"]
+    elif "fish" in shell:
+        profiles = [home / ".config" / "fish" / "config.fish"]
+    else:
+        profiles = [home / ".bashrc", home / ".bash_profile", home / ".profile"]
+
+    export_line = f'\nexport PATH="{new_path}:$PATH"\n'
+    fish_line = f'\nset -gx PATH "{new_path}" $PATH\n'
+
+    written = False
+    for profile in profiles:
+        try:
+            if profile.exists():
+                content = profile.read_text()
+                if new_path not in content:
+                    with open(profile, "a") as f:
+                        if "fish" in str(profile):
+                            f.write(fish_line)
+                        else:
+                            f.write(export_line)
+                    written = True
+                    break
+        except Exception:
+            continue
+
+    if not written:
+        try:
+            profile = home / ".profile"
+            with open(profile, "a") as f:
+                f.write(export_line)
+            written = True
+        except Exception:
+            pass
+
+    if written:
+        success(
+            f"{tool_name} added to PATH. "
+            "Please restart your terminal for changes to take effect."
+        )
+    else:
+        _show_manual_path_instructions(new_path, tool_name)
+
+
+def _show_manual_path_instructions(new_path: str, tool_name: str):
+    """Show plain English instructions for adding to PATH manually."""
+    warning(
+        f"Could not automatically add {tool_name} to PATH. Please follow these steps:"
+    )
+    print(
+        f"\n  Add this line to your terminal config file "
+        f"(~/.bashrc or ~/.zshrc):\n"
+        f'\n  export PATH="{new_path}:$PATH"\n'
+        f"\n  Then close and reopen your terminal.\n"
+    )
+
+
+def _show_manual_path_instructions_windows(new_path: str, tool_name: str):
+    """Show plain English instructions for Windows PATH."""
+    warning(f"Could not automatically add {tool_name} to PATH.")
+    print(
+        f"\n  How to add it manually on Windows:\n"
+        f"  1. Press Windows key + S, search 'Environment Variables'\n"
+        f"  2. Click 'Edit the system environment variables'\n"
+        f"  3. Click 'Environment Variables' button\n"
+        f"  4. Under 'System variables', find 'Path' and click 'Edit'\n"
+        f"  5. Click 'New' and paste this:\n"
+        f"     {new_path}\n"
+        f"  6. Click OK on all windows\n"
+        f"  7. Restart your terminal\n"
+    )
+
+
+def verify_in_path(command: str) -> bool:
+    """Verify a command is accessible in PATH after installation."""
+    try:
+        result = subprocess.run(
+            ["where", command]
+            if platform.system() == "Windows"
+            else ["which", command],
+            capture_output=True,
+            text=True,
+        )
+        return result.returncode == 0
+    except Exception:
+        return False

projectdevsetup/permissions.py

@@ -0,0 +1,95 @@
+"""
+@project  projectdevsetup
+@org      Zenith Open Source Projects
+@license  MIT License
+"""
+
+import os
+import platform
+import subprocess
+from projectdevsetup.utils.logger import error, warning
+
+
+def check_admin_windows() -> bool:
+    """Check if running as administrator on Windows."""
+    try:
+        import ctypes
+
+        return bool(ctypes.windll.shell32.IsUserAnAdmin())
+    except Exception:
+        return False
+
+
+def check_sudo_linux() -> bool:
+    """Check if sudo is available without password on Linux/Mac."""
+    try:
+        result = subprocess.run(
+            ["sudo", "-n", "true"], capture_output=True, text=True, timeout=5
+        )
+        return result.returncode == 0
+    except Exception:
+        return False
+
+
+def check_disk_space(required_gb: float = 2.0) -> bool:
+    """
+    Check if there is enough disk space.
+    Default: require at least 2GB free.
+    """
+    try:
+        import shutil
+
+        total, used, free = shutil.disk_usage("/")
+        free_gb = free / (1024**3)
+        if free_gb < required_gb:
+            error(
+                f"Not enough disk space. "
+                f"You have {free_gb:.1f}GB free but we need "
+                f"at least {required_gb}GB. "
+                f"Please free up some space and try again."
+            )
+            return False
+        return True
+    except Exception:
+        return True
+
+
+def assert_not_root() -> bool:
+    """
+    Warn if running as root on Linux.
+    Running pip packages as root is not recommended.
+    """
+    if platform.system() == "Linux":
+        try:
+            if os.geteuid() == 0:
+                warning(
+                    "You are running as root. This is not recommended. "
+                    "Please run as a normal user. "
+                    "Use sudo only when prompted."
+                )
+                return False
+        except AttributeError:
+            pass
+    return True
+
+
+def handle_no_admin_windows():
+    """Tell Windows user exactly how to get admin rights."""
+    error("Administrator rights are needed to install developer tools on Windows.")
+    print(
+        "\n  How to fix this:\n"
+        "  1. Close this window\n"
+        "  2. Find your terminal (Command Prompt or PowerShell)\n"
+        "  3. Right-click on it\n"
+        "  4. Click 'Run as administrator'\n"
+        "  5. Run the command again\n"
+    )
+
+
+def handle_no_sudo_linux():
+    """Tell Linux user exactly how to handle sudo."""
+    warning(
+        "Some installations need sudo (admin) access. "
+        "You may be asked for your password during setup. "
+        "This is normal and safe."
+    )

projectdevsetup/templates/Hello.java

@@ -0,0 +1,8 @@
+// Hello, World! — Java
+// projectdevsetup by Zenith Open Source Projects
+
+public class Hello {
+    public static void main(String[] args) {
+        System.out.println("Hello, World!");
+    }
+}

projectdevsetup/templates/__init__.py

@@ -0,0 +1,5 @@
+"""
+@project  projectdevsetup
+@org      Zenith Open Source Projects
+@license  MIT License
+"""

projectdevsetup/templates/hello.c

@@ -0,0 +1,9 @@
+/* Hello, World! — C */
+/* projectdevsetup by Zenith Open Source Projects */
+
+#include <stdio.h>
+
+int main() {
+    printf("Hello, World!\n");
+    return 0;
+}

projectdevsetup/templates/hello.cpp

@@ -0,0 +1,9 @@
+// Hello, World! — C++
+// projectdevsetup by Zenith Open Source Projects
+
+#include <iostream>
+
+int main() {
+    std::cout << "Hello, World!" << std::endl;
+    return 0;
+}

projectdevsetup/templates/hello.go

@@ -0,0 +1,10 @@
+// Hello, World! — Go
+// projectdevsetup by Zenith Open Source Projects
+
+package main
+
+import "fmt"
+
+func main() {
+	fmt.Println("Hello, World!")
+}

projectdevsetup/templates/hello.html

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<!-- Hello, World! — HTML/CSS -->
+<!-- projectdevsetup by Zenith Open Source Projects -->
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>My First Web Page</title>
+    <style>
+        body {
+            font-family: Arial, sans-serif;
+            display: flex;
+            justify-content: center;
+            align-items: center;
+            height: 100vh;
+            background: #f0f0f0;
+            margin: 0;
+        }
+        h1 { color: #333; }
+    </style>
+</head>
+<body>
+    <h1>Hello, World!</h1>
+</body>
+</html>

projectdevsetup/templates/hello.js

@@ -0,0 +1,4 @@
+// Hello, World! — JavaScript
+// projectdevsetup by Zenith Open Source Projects
+
+console.log("Hello, World!");

projectdevsetup/templates/hello.py

@@ -0,0 +1,4 @@
+# Hello, World! — Python
+# projectdevsetup by Zenith Open Source Projects
+
+print("Hello, World!")

projectdevsetup/templates/hello.rs

@@ -0,0 +1,6 @@
+// Hello, World! — Rust
+// projectdevsetup by Zenith Open Source Projects
+
+fn main() {
+    println!("Hello, World!");
+}

projectdevsetup/utils/__init__.py

@@ -0,0 +1,5 @@
+"""
+@project  projectdevsetup
+@org      Zenith Open Source Projects
+@license  MIT License
+"""

projectdevsetup/utils/logger.py

@@ -0,0 +1,69 @@
+"""
+@project  projectdevsetup
+@org      Zenith Open Source Projects
+@license  MIT License
+"""
+
+import sys
+from colorama import Fore, Style, init
+
+init(autoreset=True)
+
+
+def _safe_print(message: str):
+    """Print with UTF-8 encoding fix for Windows."""
+    try:
+        print(message)
+    except UnicodeEncodeError:
+        print(message.encode("ascii", "replace").decode("ascii"))
+
+
+def info(message: str):
+    """Blue info message."""
+    _safe_print(f"{Fore.CYAN}[projectdevsetup]{Style.RESET_ALL} {message}")
+
+
+def success(message: str):
+    """Green success message."""
+    _safe_print(f"{Fore.GREEN}[OK] {message}{Style.RESET_ALL}")
+
+
+def warning(message: str):
+    """Yellow warning message."""
+    _safe_print(f"{Fore.YELLOW}[!] {message}{Style.RESET_ALL}")
+
+
+def error(message: str):
+    """Red error message in plain English. Never show raw exceptions."""
+    _safe_print(f"{Fore.RED}[X] {message}{Style.RESET_ALL}")
+
+
+def step(number: int, total: int, message: str):
+    """Shows progress like: [2/5] Installing GCC..."""
+    _safe_print(f"{Fore.BLUE}[{number}/{total}]{Style.RESET_ALL} {message}...")
+
+
+def header():
+    """Print the welcome banner."""
+    _safe_print(f"""
+{Fore.CYAN}{"=" * 60}
+  projectdevsetup - Zenith Open Source Projects
+  Automatic Developer Environment Setup for Beginners
+{"=" * 60}{Style.RESET_ALL}
+""")
+
+
+def already_installed(tool: str):
+    """Tell user a tool is already installed - skip it."""
+    _safe_print(
+        f"{Fore.GREEN}[OK] {tool} is already installed. Skipping.{Style.RESET_ALL}"
+    )
+
+
+def ask(prompt: str) -> str:
+    """Prompt the user for input with consistent styling."""
+    return input(f"{Fore.YELLOW}>>  {prompt}{Style.RESET_ALL} ")
+
+
+def divider():
+    _safe_print(f"{Fore.CYAN}{'-' * 60}{Style.RESET_ALL}")

projectdevsetup/utils/os_detect.py

@@ -0,0 +1,142 @@
+"""
+@project  projectdevsetup
+@org      Zenith Open Source Projects
+@license  MIT License
+"""
+
+import platform
+import subprocess
+import sys
+import os
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class SystemInfo:
+    os_name: str
+    os_version: str
+    architecture: str
+    distro: str
+    distro_version: str
+    package_manager: str
+    is_64bit: bool
+    is_arm: bool
+    has_sudo: bool
+    has_display: bool
+
+
+def detect_system() -> SystemInfo:
+    """Detect all system information needed for setup decisions."""
+    raw_os = platform.system().lower()
+    arch = platform.machine().lower()
+    is_arm = arch in ("arm64", "aarch64", "armv7l", "armv6l")
+    is_64bit = sys.maxsize > 2**32
+
+    os_name = ""
+    os_version = ""
+    distro = ""
+    distro_version = ""
+    package_manager = ""
+    has_sudo = False
+    has_display = True
+
+    if raw_os == "windows":
+        os_name = "windows"
+        os_version = platform.version()
+        package_manager = _detect_windows_package_manager()
+
+    elif raw_os == "linux":
+        os_name = "linux"
+        distro, distro_version = _detect_linux_distro()
+        package_manager = _detect_linux_package_manager()
+        has_sudo = _check_sudo()
+        has_display = _check_display()
+
+    elif raw_os == "darwin":
+        os_name = "mac"
+        os_version = platform.mac_ver()[0]
+        package_manager = "brew" if _command_exists("brew") else "none"
+        has_sudo = _check_sudo()
+
+    else:
+        os_name = "unknown"
+
+    return SystemInfo(
+        os_name=os_name,
+        os_version=os_version,
+        architecture=arch,
+        distro=distro,
+        distro_version=distro_version,
+        package_manager=package_manager,
+        is_64bit=is_64bit,
+        is_arm=is_arm,
+        has_sudo=has_sudo,
+        has_display=has_display,
+    )
+
+
+def _detect_linux_distro() -> tuple:
+    """Detect Linux distribution name and version."""
+    try:
+        with open("/etc/os-release") as f:
+            lines = f.read().lower()
+        name = ""
+        version = ""
+        for line in lines.splitlines():
+            if line.startswith("id="):
+                name = line.split("=")[1].strip().strip('"')
+            if line.startswith("version_id="):
+                version = line.split("=")[1].strip().strip('"')
+        return name, version
+    except Exception:
+        return "unknown", ""
+
+
+def _detect_linux_package_manager() -> str:
+    """Return the available package manager on Linux."""
+    managers = ["apt", "pacman", "dnf", "yum", "zypper", "apk"]
+    for mgr in managers:
+        if _command_exists(mgr):
+            return mgr
+    return "none"
+
+
+def _detect_windows_package_manager() -> str:
+    """Return available package manager on Windows."""
+    if _command_exists("winget"):
+        return "winget"
+    if _command_exists("choco"):
+        return "choco"
+    return "none"
+
+
+def _command_exists(cmd: str) -> bool:
+    """Check if a shell command exists on this system."""
+    try:
+        result = subprocess.run(
+            ["where", cmd] if platform.system() == "Windows" else ["which", cmd],
+            capture_output=True,
+            text=True,
+        )
+        return result.returncode == 0
+    except Exception:
+        return False
+
+
+def _check_sudo() -> bool:
+    """Check if sudo is available on Linux/Mac."""
+    try:
+        result = subprocess.run(["sudo", "-n", "true"], capture_output=True, text=True)
+        return result.returncode == 0
+    except Exception:
+        return False
+
+
+def _check_display() -> bool:
+    """Check if a display is available (for headless Linux detection)."""
+    return bool(
+        os.environ.get("DISPLAY")
+        or os.environ.get("WAYLAND_DISPLAY")
+        or platform.system() != "Linux"
+    )

projectdevsetup/utils/venv_helper.py

@@ -0,0 +1,95 @@
+"""
+@project  projectdevsetup
+@org      Zenith Open Source Projects
+@license  MIT License
+"""
+
+import subprocess
+import platform
+from pathlib import Path
+from projectdevsetup.utils.logger import info, success, warning, error
+
+
+def create_venv(project_dir: Path) -> bool:
+    """
+    Create a Python virtual environment inside the project directory.
+    Shows beginner-friendly instructions on how to use it.
+    Returns True on success.
+    """
+    venv_path = project_dir / ".venv"
+
+    if venv_path.exists():
+        success("Virtual environment already exists. Skipping.")
+        _show_venv_instructions(venv_path)
+        return True
+
+    info("Creating Python virtual environment (.venv)...")
+    try:
+        result = subprocess.run(
+            ["python3", "-m", "venv", str(venv_path)],
+            capture_output=True,
+            text=True,
+            timeout=60,
+        )
+        if result.returncode != 0:
+            result = subprocess.run(
+                ["python", "-m", "venv", str(venv_path)],
+                capture_output=True,
+                text=True,
+                timeout=60,
+            )
+        if result.returncode == 0:
+            success("Virtual environment created!")
+            _create_requirements_txt(project_dir)
+            _show_venv_instructions(venv_path)
+            return True
+        else:
+            error(
+                "Could not create virtual environment. "
+                "Make sure Python is properly installed."
+            )
+            return False
+    except Exception:
+        error(
+            "Failed to create virtual environment. "
+            "Please make sure python3-venv is installed."
+        )
+        return False
+
+
+def _create_requirements_txt(project_dir: Path):
+    """Create an empty requirements.txt with instructions."""
+    req_file = project_dir / "requirements.txt"
+    if not req_file.exists():
+        req_file.write_text(
+            "# Add your Python packages here, one per line.\n"
+            "# Example:\n"
+            "# requests\n"
+            "# numpy\n"
+            "#\n"
+            "# To install all packages, run:\n"
+            "# pip install -r requirements.txt\n"
+        )
+        success("requirements.txt created.")
+
+
+def _show_venv_instructions(venv_path: Path):
+    """Show beginner-friendly venv activation instructions."""
+    os_name = platform.system().lower()
+
+    if os_name == "windows":
+        activate_cmd = f".venv\\Scripts\\activate"
+    else:
+        activate_cmd = "source .venv/bin/activate"
+
+    print(f"""
+  ┌─────────────────────────────────────────────┐
+  │  How to use your virtual environment:       │
+  │                                             │
+  │  1. Open your terminal in this folder      │
+  │  2. Type: {activate_cmd:<35} │
+  │  3. You will see (.venv) appear             │
+  │  4. Install packages: pip install <name>   │
+  │  5. To deactivate: type deactivate          │
+  └─────────────────────────────────────────────┘
+""")