smart-deploy 0.1.0__tar.gz

smart_deploy-0.1.0/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: smart-deploy
+Version: 0.1.0
+Requires-Dist: typer
+Requires-Dist: fastapi
+Requires-Dist: uvicorn
+Requires-Dist: requests
+Requires-Dist: pydantic
+Dynamic: requires-dist

smart_deploy-0.1.0/README.md

@@ -0,0 +1,103 @@
+# 🚀 Smart Deploy
+
+![Python Version](https://img.shields.io/badge/python-3.8%2B-blue)
+![License](https://img.shields.io/badge/license-MIT-green)
+![FastAPI](https://img.shields.io/badge/FastAPI-0.100%2B-009688?logo=fastapi)
+![Typer](https://img.shields.io/badge/Typer-CLI-000000)
+
+**Smart Deploy** is a lightweight, zero-configuration CI/CD tool designed for independent developers and small teams. It bridges the gap between your GitHub repositories and your Linux server, automating the entire deployment process with a single command.
+
+No complex YAML files. No heavy Jenkins pipelines. Just raw efficiency.
+
+## ✨ Features
+
+- **Zero-Config Webhooks**: Automatically configures GitHub webhooks using your Personal Access Token.
+- **Smart Framework Detection**: Automatically detects Node.js (Next.js/React) and Python projects.
+- **Auto Dependency Resolution**: Runs `npm install`, `npm run build`, or `pip install` based on your project's ecosystem.
+- **Custom Post-Deploy Commands**: Seamlessly integrates with process managers like PM2 or Systemd.
+- **Multi-Project Support**: Manage dozens of projects on a single server with one lightweight background listener.
+
+---
+
+## 📦 Installation
+
+Since Smart Deploy is built with Python, you can install it directly on your server using `pip`:
+
+```bash
+# Clone the repository
+git clone [https://github.com/AmirtahaNemati/smart-deploy.git](https://github.com/AmirtahaNemati/smart-deploy.git)
+cd smart-deploy
+
+# Install the package globally
+pip install -e .
+```
+
+---
+
+## 🚀 Quick Start
+
+### 1. Start the Listener
+
+Spin up the background FastAPI server that listens for GitHub push events.
+
+```bash
+smart-deploy start --port 9000
+
+```
+
+_(Tip: In a production environment, run this using `nohup` or create a `systemd` service to keep it alive in the background)._
+
+### 2. Register Your Project
+
+Link your GitHub repository to a local directory on your server. Smart Deploy will automatically configure the GitHub webhook for you.
+
+```bash
+smart-deploy add [https://github.com/YourUsername/your-repo](https://github.com/YourUsername/your-repo) /var/www/your-project http://YOUR_SERVER_IP:9000 --token "ghp_your_github_token" --restart "pm2 restart my-app"
+
+```
+
+**Parameters Explained:**
+
+- `https://.../your-repo`: The target GitHub repository.
+- `/var/www/your-project`: The absolute path to your project on the server.
+- `http://YOUR_SERVER_IP:9000`: Your server's public URL/IP and the port the listener is running on.
+- `--token`: Your GitHub Personal Access Token (requires `repo` scope to set up webhooks).
+- `--restart`: (Optional) The command to run after pulling and building the code.
+
+### 3. Push and Relax
+
+Now, simply push your code from your local machine:
+
+```bash
+git commit -m "feat: awesome new feature"
+git push origin main
+
+```
+
+Smart Deploy will intercept the webhook, pull the latest code, install dependencies, build the project, and restart the service automatically.
+
+---
+
+## 🧠 How the Smart Detector Works
+
+When a webhook is triggered, Smart Deploy analyzes the target directory:
+
+1. **Next.js / Node.js**: If `package.json` and `next.config.js` are found, it executes `npm install` followed by `npm run build`.
+2. **Python**: If `requirements.txt` is found, it automatically locates your virtual environment (`venv`) and runs `pip install -r requirements.txt`.
+3. **Custom Execution**: Finally, it runs the custom restart command provided during the `add` step.
+
+---
+
+## 🛠️ CLI Commands Reference
+
+- `smart-deploy add`: Register a new project and set up webhooks.
+- `smart-deploy start`: Launch the FastAPI webhook receiver.
+- `smart-deploy --help`: View the detailed help menu.
+
+---
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](https://www.google.com/search?q=LICENSE&utm_source=gemini) file for details.
+
+Developed with ❤️ by [Amirtaha Nemati](https://www.google.com/search?q=https://github.com/AmirtahaNemati&utm_source=gemini).

smart_deploy-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

smart_deploy-0.1.0/setup.py

@@ -0,0 +1,19 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="smart-deploy",
+    version="0.1.0",
+    packages=find_packages(),
+    install_requires=[
+        "typer",
+        "fastapi",
+        "uvicorn",
+        "requests",
+        "pydantic"
+    ],
+    entry_points={
+        "console_scripts": [
+            "smart-deploy=smart_deploy.cli:app",
+        ],
+    },
+)

smart_deploy-0.1.0/smart_deploy/cli.py

@@ -0,0 +1,83 @@
+import typer
+import shutil
+import getpass
+import subprocess
+from .database import save_project
+from .github_api import setup_webhook
+
+app = typer.Typer(help="Smart Deploy: Automated CI/CD Tool for Developers")
+
+@app.command()
+def add(
+    repo_url: str = typer.Argument(..., help="Target GitHub Repository URL"),
+    path: str = typer.Argument(..., help="Absolute local path on the server"),
+    server_url: str = typer.Argument(..., help="Public URL or IP of this server (e.g., http://8.8.8.8:9000)"),
+    token: str = typer.Option(None, "--token", "-t", help="GitHub Personal Access Token (requires 'repo' permissions)"),
+    restart_cmd: str = typer.Option(None, "--restart", "-r", help="Custom command to run after deployment (e.g., 'pm2 restart api')")
+):
+    """
+    Register a new project and automatically configure its GitHub webhook.
+    """
+    typer.echo(f"Registering project: {repo_url} at {path}")
+    
+    # ذخیره کانفیگ پروژه در سیستم جهت ارجاع هنگام دریافت درخواست وب‌هوک
+    repo_name = save_project(repo_url, path, token, restart_cmd)
+    typer.secho(f"Project '{repo_name}' successfully added to the local database.", fg=typer.colors.GREEN)
+    
+    # در صورت وجود توکن، ارتباط با گیت‌هاب و ثبت وب‌هوک آغاز می‌شود
+    if token:
+        typer.echo("Initiating automated GitHub webhook configuration...")
+        if setup_webhook(repo_name, token, server_url):
+            typer.secho("GitHub Webhook configured successfully.", fg=typer.colors.GREEN)
+        else:
+            typer.secho("Failed to configure GitHub Webhook. Verify token permissions.", fg=typer.colors.RED)
+    else:
+        typer.secho("Warning: No token provided. Automated webhook configuration skipped.", fg=typer.colors.YELLOW)
+
+@app.command()
+def start(port: int = typer.Option(9000, "--port", "-p", help="Port number for the webhook listener")):
+    """
+    Start the background FastAPI server to listen for GitHub webhooks.
+    """
+    typer.secho(f"Initializing Smart Deploy Listener on port {port}...", fg=typer.colors.CYAN)
+    
+    # فراخوانی Uvicorn به عنوان سرور اجرای FastAPI
+    subprocess.run(["uvicorn", "smart_deploy.server:app", "--host", "0.0.0.0", "--port", str(port)])
+
+@app.command()
+def generate_service(port: int = typer.Option(9000, "--port", "-p", help="Port number for the webhook listener")):
+    """
+    Generate a systemd service configuration for Linux servers to run in the background.
+    """
+    # پیدا کردن مسیر دقیق فایل اجرایی و نام کاربری لینوکس
+    executable = shutil.which("smart-deploy") or "/usr/local/bin/smart-deploy"
+    user = getpass.getuser()
+    
+    service_content = f"""[Unit]
+Description=Smart Deploy Webhook Listener
+After=network.target
+
+[Service]
+User={user}
+ExecStart={executable} start --port {port}
+Restart=always
+RestartSec=3
+
+[Install]
+WantedBy=multi-user.target
+"""
+    
+    typer.secho("1. Create a new service file using nano:", fg=typer.colors.CYAN)
+    typer.echo("sudo nano /etc/systemd/system/smart-deploy.service\n")
+    
+    typer.secho("2. Paste the following configuration into the file:\n", fg=typer.colors.CYAN)
+    typer.echo(service_content)
+    
+    typer.secho("3. Enable and start the service by running:", fg=typer.colors.YELLOW)
+    typer.echo("sudo systemctl daemon-reload")
+    typer.echo("sudo systemctl enable smart-deploy")
+    typer.echo("sudo systemctl start smart-deploy")
+    typer.echo("sudo systemctl status smart-deploy")
+
+if __name__ == "__main__":
+    app()

smart_deploy-0.1.0/smart_deploy/database.py

@@ -0,0 +1,44 @@
+import json
+from pathlib import Path
+from typing import Optional
+
+# تعیین مسیر ذخیره‌سازی اطلاعات پروژه‌ها در دایرکتوری کاربر تا با حذف برنامه دیتابیس پاک نشود
+CONFIG_DIR = Path.home() / ".smart-deploy"
+DB_FILE = CONFIG_DIR / "projects.json"
+
+def init_db():
+    """Initialize the database directory and file if they don't exist."""
+    CONFIG_DIR.mkdir(exist_ok=True)
+    if not DB_FILE.exists():
+        with open(DB_FILE, "w") as f:
+            json.dump({}, f)
+
+def load_projects() -> dict:
+    """Load all projects from the JSON database."""
+    init_db()
+    with open(DB_FILE, "r") as f:
+        return json.load(f)
+
+def save_project(repo_url: str, path: str, token: Optional[str] = None, restart_cmd: Optional[str] = None) -> str:
+    """Save a new project to the database and return the extracted repository name."""
+    projects = load_projects()
+    
+    # استخراج شناسه یکتای ریپازیتوری از لینک برای استفاده به عنوان کلید اصلی
+    repo_name = repo_url.replace("https://github.com/", "").replace(".git", "")
+    
+    projects[repo_name] = {
+        "repo_url": repo_url,
+        "path": path,
+        "token": token,
+        "restart_cmd": restart_cmd
+    }
+    
+    with open(DB_FILE, "w") as f:
+        json.dump(projects, f, indent=4)
+        
+    return repo_name
+    
+def get_project(repo_name: str) -> Optional[dict]:
+    """Retrieve project configuration by repository name."""
+    projects = load_projects()
+    return projects.get(repo_name)

smart_deploy-0.1.0/smart_deploy/detector.py

@@ -0,0 +1,61 @@
+import os
+import subprocess
+from typing import Optional
+
+def run_command(command: str, cwd: str) -> bool:
+    """Execute a shell command in the specified directory and print the output."""
+    print(f"Executing: [{command}] in {cwd}")
+    try:
+        result = subprocess.run(
+            command, 
+            shell=True, 
+            cwd=cwd, 
+            stdout=subprocess.PIPE, 
+            stderr=subprocess.PIPE,
+            text=True
+        )
+        if result.returncode == 0:
+            print(f"Success:\n{result.stdout.strip()}")
+            return True
+        else:
+            print(f"Error:\n{result.stderr.strip()}")
+            return False
+    except Exception as e:
+        print(f"System Exception: {e}")
+        return False
+
+def pull_repo(path: str, token: Optional[str], repo_url: str) -> bool:
+    """Pull the latest changes from the remote repository."""
+    if token:
+        # تزریق مستقیم توکن به آدرس ریپازیتوری برای دور زدن نیاز به احراز هویت تعاملی در سرور
+        url_without_protocol = repo_url.replace("https://", "")
+        auth_url = f"https://{token}@{url_without_protocol}"
+        run_command(f"git remote set-url origin {auth_url}", path)
+    
+    return run_command("git pull", path)
+
+def detect_and_deploy(path: str, restart_cmd: Optional[str] = None):
+    """Analyze the project structure and run appropriate build commands."""
+    
+    # بررسی وجود فایل‌های پایه جاوا اسکریپت برای تشخیص فریم‌ورک‌های مبتنی بر Node
+    if os.path.exists(os.path.join(path, "package.json")):
+        print("Framework detected: Node.js")
+        run_command("npm install", path)
+        
+        if os.path.exists(os.path.join(path, "next.config.js")) or os.path.exists(os.path.join(path, "next.config.mjs")):
+            print("Framework detected: Next.js")
+            run_command("npm run build", path)
+            
+    # بررسی ساختار پروژه‌های پایتونی
+    elif os.path.exists(os.path.join(path, "requirements.txt")):
+        print("Framework detected: Python")
+        # اولویت استفاده از محیط مجازی در صورت وجود برای جلوگیری از تداخل پکیج‌ها در سرور
+        pip_cmd = "venv/bin/pip" if os.path.exists(os.path.join(path, "venv")) else "pip"
+        run_command(f"{pip_cmd} install -r requirements.txt", path)
+
+    # اجرای دستور ری‌استارت شخصی‌سازی شده در صورت تعریف توسط کاربر
+    if restart_cmd:
+        print(f"Executing custom restart command: {restart_cmd}")
+        run_command(restart_cmd, path)
+    else:
+        print("No custom restart command provided. Deployment cycle completed.")

smart_deploy-0.1.0/smart_deploy/github_api.py

@@ -0,0 +1,46 @@
+import requests
+
+def setup_webhook(repo_name: str, token: str, server_url: str) -> bool:
+    """Configure a push webhook on the target GitHub repository."""
+    api_url = f"https://api.github.com/repos/{repo_name}/hooks"
+    target_webhook_url = f"{server_url}/webhook"
+    
+    headers = {
+        "Authorization": f"token {token}",
+        "Accept": "application/vnd.github.v3+json"
+    }
+    
+    payload = {
+        "name": "web",
+        "active": True,
+        "events": ["push"],
+        "config": {
+            "url": target_webhook_url,
+            "content_type": "json",
+            "insecure_ssl": "1" # مجاز کردن کانکشن‌های بدون SSL برای سرورهای تستی
+        }
+    }
+    
+    # بررسی وب‌هوک‌های فعلی ریپازیتوری برای جلوگیری از ثبت آدرس تکراری
+    try:
+        response = requests.get(api_url, headers=headers)
+        if response.status_code == 200:
+            for hook in response.json():
+                if hook.get("config", {}).get("url") == target_webhook_url:
+                    print(f"Webhook configuration already exists for {target_webhook_url}")
+                    return True
+    except Exception as e:
+        print(f"Failed to fetch existing webhooks: {e}")
+        
+    # ثبت وب‌هوک جدید روی ریپازیتوری
+    try:
+        response = requests.post(api_url, headers=headers, json=payload)
+        if response.status_code == 201:
+            print("Webhook successfully registered on GitHub.")
+            return True
+        else:
+            print(f"Webhook registration failed [{response.status_code}]: {response.text}")
+            return False
+    except Exception as e:
+        print(f"Exception occurred during webhook registration: {e}")
+        return False

smart_deploy-0.1.0/smart_deploy/server.py

@@ -0,0 +1,40 @@
+from fastapi import FastAPI, Request, HTTPException, BackgroundTasks
+from .database import get_project
+from .detector import pull_repo, detect_and_deploy
+
+app = FastAPI(title="Smart Deploy Webhook Receiver")
+
+def handle_deployment(project_info: dict):
+    """Background task to handle the deployment process."""
+    path = project_info.get("path")
+    token = project_info.get("token")
+    repo_url = project_info.get("repo_url")
+    restart_cmd = project_info.get("restart_cmd")
+
+    print(f"--- Initiating deployment pipeline for {repo_url} ---")
+    
+    if pull_repo(path, token, repo_url):
+        detect_and_deploy(path, restart_cmd)
+        print("--- Deployment pipeline executed successfully ---")
+    else:
+        print("--- Deployment pipeline aborted: Pull operation failed ---")
+
+@app.post("/webhook")
+async def github_webhook(request: Request, background_tasks: BackgroundTasks):
+    """Endpoint for receiving GitHub webhook push events."""
+    payload = await request.json()
+    
+    # استخراج نام کامل ریپازیتوری از دیتای ارسالی گیت‌هاب جهت تطبیق با دیتابیس محلی
+    try:
+        repo_name = payload["repository"]["full_name"]
+    except KeyError:
+        raise HTTPException(status_code=400, detail="Malformed GitHub payload structure.")
+
+    project_info = get_project(repo_name)
+    if not project_info:
+        raise HTTPException(status_code=404, detail=f"Repository '{repo_name}' is not registered in Smart Deploy.")
+
+    # اجرای پروسه در پس‌زمینه تا سرور گیت‌هاب با خطای Timeout به دلیل طولانی شدن زمان بیلد مواجه نشود
+    background_tasks.add_task(handle_deployment, project_info)
+    
+    return {"status": "Deployment job queued successfully", "repository": repo_name}

smart_deploy-0.1.0/smart_deploy.egg-info/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: smart-deploy
+Version: 0.1.0
+Requires-Dist: typer
+Requires-Dist: fastapi
+Requires-Dist: uvicorn
+Requires-Dist: requests
+Requires-Dist: pydantic
+Dynamic: requires-dist

smart_deploy-0.1.0/smart_deploy.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+README.md
+setup.py
+smart_deploy/__init__.py
+smart_deploy/cli.py
+smart_deploy/database.py
+smart_deploy/detector.py
+smart_deploy/github_api.py
+smart_deploy/server.py
+smart_deploy.egg-info/PKG-INFO
+smart_deploy.egg-info/SOURCES.txt
+smart_deploy.egg-info/dependency_links.txt
+smart_deploy.egg-info/entry_points.txt
+smart_deploy.egg-info/requires.txt
+smart_deploy.egg-info/top_level.txt

smart_deploy-0.1.0/smart_deploy.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

smart_deploy-0.1.0/smart_deploy.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+smart-deploy = smart_deploy.cli:app

smart_deploy-0.1.0/smart_deploy.egg-info/requires.txt

@@ -0,0 +1,5 @@
+typer
+fastapi
+uvicorn
+requests
+pydantic

smart_deploy-0.1.0/smart_deploy.egg-info/top_level.txt

@@ -0,0 +1 @@
+smart_deploy