predeploy-doctor 0.1.0__tar.gz

predeploy_doctor-0.1.0/.gitignore

@@ -0,0 +1,23 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.whl
+
+# Virtual environments
+venv/
+.venv/
+env/
+
+# Configuration and secrets
+.env
+predeploy.yaml
+
+# OS generated files
+.DS_Store
+Thumbs.db

predeploy_doctor-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Pre-Deploy Doctor Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

predeploy_doctor-0.1.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: predeploy-doctor
+Version: 0.1.0
+Summary: A local DevOps readiness checker for safer deployments.
+Author: AyaanB24
+License: MIT
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.8
+Requires-Dist: click>=8.0.0
+Requires-Dist: psutil>=5.9.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pyyaml>=6.0
+Description-Content-Type: text/markdown
+
+# 🩺 Pre-Deploy Doctor
+
+**Pre-Deploy Doctor** is a local DevOps readiness checker that validates whether your environment is safe to deploy BEFORE you run Docker, kubectl, or CI/CD pipelines.
+
+It runs 100% locally, requires no cloud accounts or AI, and is designed to catch common "stupid" mistakes before they hit your production infrastructure.
+
+## 🚀 Features
+
+- **Docker Health**: Checks if Docker is installed and the daemon is actually running.
+- **Environment Validation**: Loads `.env` and validates that your required environment variables are set.
+- **Port Conflicts**: Identifies if required ports are already in use and shows the conflicting process name.
+- **Kubernetes Context Safety**: Warns you if your `kubectl` context isn't in your "allowed" list for the project.
+- **Project Structure**: Ensures critical files like `Dockerfile` are present.
+
+## 📦 Installation
+
+```bash
+pip install predeploy-doctor
+```
+
+## 🛠 Usage
+
+Run inside any project directory:
+
+```bash
+predeploy check
+```
+
+### Configuration (`predeploy.yaml`)
+
+Create a `predeploy.yaml` in your project root to customize the checks:
+
+```yaml
+required_env:
+  - DB_URL
+  - SECRET_KEY
+
+required_ports:
+  - 3000
+  - 5432
+
+kubernetes:
+  allowed_contexts:
+    - dev
+    - staging
+    - minikube
+```
+
+## 📋 Sample Output
+
+```text
+🩺 Pre-Deploy Doctor Report
+
+✔ Docker is running
+✔ Found Dockerfile
+✔ All required environment variables are set
+❌ Port 3000 already in use (Process: node)
+⚠ Kubernetes context 'production' not in allowed list
+
+==============================
+Status: ❌ NOT SAFE TO DEPLOY
+```
+
+## 🔢 Exit Codes
+
+- `0`: All checks passed (or only warnings). Safe to deploy.
+- `1`: One or more critical checks failed. **Deployment should be blocked.**
+
+## 📜 License
+
+MIT

predeploy_doctor-0.1.0/README.md

@@ -0,0 +1,71 @@
+# 🩺 Pre-Deploy Doctor
+
+**Pre-Deploy Doctor** is a local DevOps readiness checker that validates whether your environment is safe to deploy BEFORE you run Docker, kubectl, or CI/CD pipelines.
+
+It runs 100% locally, requires no cloud accounts or AI, and is designed to catch common "stupid" mistakes before they hit your production infrastructure.
+
+## 🚀 Features
+
+- **Docker Health**: Checks if Docker is installed and the daemon is actually running.
+- **Environment Validation**: Loads `.env` and validates that your required environment variables are set.
+- **Port Conflicts**: Identifies if required ports are already in use and shows the conflicting process name.
+- **Kubernetes Context Safety**: Warns you if your `kubectl` context isn't in your "allowed" list for the project.
+- **Project Structure**: Ensures critical files like `Dockerfile` are present.
+
+## 📦 Installation
+
+```bash
+pip install predeploy-doctor
+```
+
+## 🛠 Usage
+
+Run inside any project directory:
+
+```bash
+predeploy check
+```
+
+### Configuration (`predeploy.yaml`)
+
+Create a `predeploy.yaml` in your project root to customize the checks:
+
+```yaml
+required_env:
+  - DB_URL
+  - SECRET_KEY
+
+required_ports:
+  - 3000
+  - 5432
+
+kubernetes:
+  allowed_contexts:
+    - dev
+    - staging
+    - minikube
+```
+
+## 📋 Sample Output
+
+```text
+🩺 Pre-Deploy Doctor Report
+
+✔ Docker is running
+✔ Found Dockerfile
+✔ All required environment variables are set
+❌ Port 3000 already in use (Process: node)
+⚠ Kubernetes context 'production' not in allowed list
+
+==============================
+Status: ❌ NOT SAFE TO DEPLOY
+```
+
+## 🔢 Exit Codes
+
+- `0`: All checks passed (or only warnings). Safe to deploy.
+- `1`: One or more critical checks failed. **Deployment should be blocked.**
+
+## 📜 License
+
+MIT

predeploy_doctor-0.1.0/predeploy/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

predeploy_doctor-0.1.0/predeploy/checks/docker.py

@@ -0,0 +1,27 @@
+import subprocess
+import shutil
+
+def check_docker():
+    """
+    Checks if Docker is installed and running.
+    Returns: (bool, str) - (Success, Message)
+    """
+    if not shutil.which("docker"):
+        return False, "Docker is not installed"
+    
+    try:
+        # 'docker info' returns 0 if daemon is running
+        process = subprocess.run(
+            ["docker", "info"], 
+            stdout=subprocess.DEVNULL, 
+            stderr=subprocess.DEVNULL,
+            timeout=5
+        )
+        if process.returncode == 0:
+            return True, "Docker is running"
+        else:
+            return False, "Docker daemon is not running"
+    except subprocess.TimeoutExpired:
+        return False, "Docker info command timed out (daemon might be unresponsive)"
+    except Exception as e:
+        return False, f"Error checking Docker: {str(e)}"

predeploy_doctor-0.1.0/predeploy/checks/env.py

@@ -0,0 +1,21 @@
+import os
+
+def check_env(config):
+    """
+    Validates required environment variables from config.
+    Returns: list of (bool, str) - (Success, Message)
+    """
+    required_vars = config.get("required_env", [])
+    if not required_vars:
+        return [(True, "No required environment variables specified")]
+
+    results = []
+    missing_vars = []
+    for var in required_vars:
+        if not os.environ.get(var):
+            missing_vars.append(var)
+    
+    if not missing_vars:
+        return [(True, "All required environment variables are set")]
+    else:
+        return [(False, f"Missing environment variables: {', '.join(missing_vars)}")]

predeploy_doctor-0.1.0/predeploy/checks/files.py

@@ -0,0 +1,28 @@
+from pathlib import Path
+
+def check_files():
+    """
+    Checks for presence of critical project files.
+    Returns: list of (bool, str) - (Success, Message)
+    """
+    results = []
+    
+    # Critical files
+    critical_files = ["Dockerfile", "docker-compose.yml"]
+    found_any = False
+    
+    for filename in critical_files:
+        if Path(filename).exists():
+            results.append((True, f"Found {filename}"))
+            found_any = True
+        else:
+            # We only fail if NONE of them exist or if they are expected?
+            # User said: "Missing critical files -> FAIL"
+            # I'll report success for what's found and maybe warning for what's missing
+            # but if it's a Docker project, a Dockerfile is usually mandatory.
+            pass
+
+    if not found_any:
+        return [(False, "No Dockerfile or docker-compose.yml found in current directory")]
+    
+    return results

predeploy_doctor-0.1.0/predeploy/checks/k8s.py

@@ -0,0 +1,38 @@
+import subprocess
+import shutil
+
+def check_k8s(config):
+    """
+    Checks if kubectl is installed and context is allowed.
+    Returns: list of (bool, str, str) - (Success, Message, Level)
+    Level can be 'fail', 'warning', 'success'
+    """
+    if not shutil.which("kubectl"):
+        return [(True, "kubectl is not installed", "warning")]
+
+    try:
+        result = subprocess.run(
+            ["kubectl", "config", "current-context"],
+            capture_output=True,
+            text=True,
+            encoding="utf-8",
+            errors="ignore",
+            timeout=5
+        )
+        if result.returncode != 0:
+            return [(True, "Could not determine kubectl context", "warning")]
+        
+        current_context = result.stdout.strip()
+        k8s_config = config.get("kubernetes", {})
+        allowed_contexts = k8s_config.get("allowed_contexts", [])
+
+        if not allowed_contexts:
+            return [(True, f"Kubernetes context: {current_context}", "warning")]
+
+        if current_context in allowed_contexts:
+            return [(True, f"Kubernetes context '{current_context}' is allowed", "success")]
+        else:
+            return [(True, f"Kubernetes context '{current_context}' not in allowed list", "warning")]
+
+    except Exception as e:
+        return [(True, f"Error checking Kubernetes: {str(e)}", "warning")]

predeploy_doctor-0.1.0/predeploy/checks/ports.py

@@ -0,0 +1,33 @@
+import psutil
+
+def check_ports(config):
+    """
+    Checks if required ports are available.
+    Returns: list of (bool, str) - (Success, Message)
+    """
+    required_ports = config.get("required_ports", [])
+    if not required_ports:
+        return [(True, "No required ports specified")]
+
+    results = []
+    # Get all active connections
+    connections = psutil.net_connections()
+    
+    in_use = {}
+    for conn in connections:
+        if conn.laddr.port in required_ports and conn.status == 'LISTEN':
+            # Try to find the process name
+            try:
+                process = psutil.Process(conn.pid)
+                name = process.name()
+            except (psutil.NoSuchProcess, psutil.AccessDenied):
+                name = "Unknown"
+            in_use[conn.laddr.port] = name
+
+    for port in required_ports:
+        if port in in_use:
+            results.append((False, f"Port {port} already in use (Process: {in_use[port]})"))
+        else:
+            results.append((True, f"Port {port} is available"))
+            
+    return results

predeploy_doctor-0.1.0/predeploy/cli.py

@@ -0,0 +1,85 @@
+import sys
+import click
+from .config import load_config, load_environment
+from .checks.docker import check_docker
+from .checks.env import check_env
+from .checks.ports import check_ports
+from .checks.k8s import check_k8s
+from .checks.files import check_files
+
+# Constants for status symbols
+SUCCESS = "✔"
+FAILURE = "❌"
+WARNING = "⚠"
+
+@click.group()
+def main():
+    """🩺 Pre-Deploy Doctor: A local DevOps readiness checker."""
+    pass
+
+@main.command()
+def check():
+    """Run all readiness checks."""
+    click.echo("\n🩺 Pre-Deploy Doctor Report\n")
+    
+    config = load_config()
+    load_environment()
+    
+    overall_safe = True
+    
+    # 1. Docker Check
+    docker_success, docker_msg = check_docker()
+    if docker_success:
+        click.secho(f"{SUCCESS} {docker_msg}", fg="green")
+    else:
+        click.secho(f"{FAILURE} {docker_msg}", fg="red")
+        overall_safe = False
+
+    # 2. File Checks
+    file_results = check_files()
+    for success, msg in file_results:
+        if success:
+            click.secho(f"{SUCCESS} {msg}", fg="green")
+        else:
+            click.secho(f"{FAILURE} {msg}", fg="red")
+            overall_safe = False
+
+    # 3. Env Checks
+    env_results = check_env(config)
+    for success, msg in env_results:
+        if success:
+            click.secho(f"{SUCCESS} {msg}", fg="green")
+        else:
+            click.secho(f"{FAILURE} {msg}", fg="red")
+            overall_safe = False
+
+    # 4. Port Checks
+    port_results = check_ports(config)
+    for success, msg in port_results:
+        if success:
+            click.secho(f"{SUCCESS} {msg}", fg="green")
+        else:
+            click.secho(f"{FAILURE} {msg}", fg="red")
+            overall_safe = False
+
+    # 5. K8s Checks (Warnings)
+    k8s_results = check_k8s(config)
+    for success, msg, level in k8s_results:
+        if level == "success":
+            click.secho(f"{SUCCESS} {msg}", fg="green")
+        elif level == "warning":
+            click.secho(f"{WARNING} {msg}", fg="yellow")
+        else:
+            click.secho(f"{FAILURE} {msg}", fg="red")
+            overall_safe = False
+
+    click.echo("\n" + "="*30)
+    if overall_safe:
+        click.secho(f"Status: {SUCCESS} SAFE TO DEPLOY", bold=True, fg="green")
+        sys.exit(0)
+    else:
+        click.secho(f"Status: {FAILURE} NOT SAFE TO DEPLOY", bold=True, fg="red")
+        sys.exit(1)
+
+if __name__ == "__main__":
+    main()

predeploy_doctor-0.1.0/predeploy/config.py

@@ -0,0 +1,26 @@
+import os
+import yaml
+from pathlib import Path
+from dotenv import load_dotenv
+
+def load_config():
+    """
+    Loads predeploy.yaml if it exists.
+    Returns a dictionary of configuration.
+    """
+    config_path = Path("predeploy.yaml")
+    if config_path.exists():
+        try:
+            with open(config_path, "r", encoding="utf-8") as f:
+                return yaml.safe_load(f) or {}
+        except Exception:
+            return {}
+    return {}
+
+def load_environment():
+    """
+    Loads .env file if present in the current directory.
+    """
+    dotenv_path = Path(".env")
+    if dotenv_path.exists():
+        load_dotenv(dotenv_path)

predeploy_doctor-0.1.0/predeploy.yaml.example

@@ -0,0 +1,18 @@
+# 🩺 Pre-Deploy Doctor Configuration Example
+# Copy this to 'predeploy.yaml' and modify it for your project.
+
+# Environment variables that MUST be set
+required_env:
+  - DB_URL
+  - SECRET_KEY
+
+# Ports that MUST be available
+required_ports:
+  - 3000
+
+# Kubernetes Safety
+kubernetes:
+  allowed_contexts:
+    - dev-cluster
+    - docker-desktop
+    - minikube

predeploy_doctor-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "predeploy-doctor"
+version = "0.1.0"
+description = "A local DevOps readiness checker for safer deployments."
+readme = "README.md"
+authors = [
+    { name = "AyaanB24" }
+]
+license = { text = "MIT" }
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Build Tools",
+    "Topic :: System :: Systems Administration",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "click>=8.0.0",
+    "PyYAML>=6.0",
+    "psutil>=5.9.0",
+    "python-dotenv>=1.0.0",
+]
+
+[project.scripts]
+predeploy = "predeploy.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["predeploy"]