django-deploy-toolkit 0.1.0__tar.gz

django_deploy_toolkit-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Antu Saha and django-deploy-toolkit 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.

django_deploy_toolkit-0.1.0/PKG-INFO

@@ -0,0 +1,306 @@
+Metadata-Version: 2.4
+Name: django-deploy-toolkit
+Version: 0.1.0
+Summary: Auto-generate and install Gunicorn & Nginx configuration for Django projects on Ubuntu/Debian.
+Author: Antu Saha
+Maintainer: Antu Saha
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/antusaha970/django-deploy-toolkit
+Project-URL: Issues, https://github.com/antusaha970/django-deploy-toolkit/issues
+Project-URL: Documentation, https://github.com/antusaha970/django-deploy-toolkit#readme
+Project-URL: Changelog, https://github.com/antusaha970/django-deploy-toolkit/blob/main/CHANGELOG.md
+Keywords: django,deployment,gunicorn,nginx,systemd,devops,automation
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Installation/Setup
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0
+Requires-Dist: rich>=12.0
+Requires-Dist: jinja2>=3.0
+Requires-Dist: psutil>=5.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.0; extra == "dev"
+Requires-Dist: coverage>=7.0; extra == "dev"
+Dynamic: license-file
+
+# django-deploy-toolkit
+
+**Auto-generate and install Gunicorn & Nginx configuration for Django projects on Ubuntu/Debian.**
+
+`django-deploy-toolkit` detects your Django project's configuration, generates production-ready systemd service/socket files and Nginx server blocks, and installs them — all with a single command. It handles edge cases gracefully, supports dry-run mode, and includes full rollback on failure.
+
+---
+
+## Created By
+
+**Antu Saha** — creator and lead maintainer of this package.
+
+We also appreciate all the open-source contributors who help improve `django-deploy-toolkit`. Contributions of any kind are welcome — bug reports, feature requests, documentation improvements, and code contributions. See the [Contributing](#contributing) section below to get started.
+
+---
+
+## Requirements
+
+- **OS:** Ubuntu / Debian Linux
+- **Python:** 3.8 or higher
+- **Django project** with a `manage.py` file
+- **Gunicorn** installed in the project's virtual environment
+- **Nginx** installed on the server (`sudo apt install nginx`)
+- **systemd** available (standard on Ubuntu/Debian)
+
+---
+
+## Installation
+
+```bash
+pip install django-deploy-toolkit
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/antusaha970/django-deploy-toolkit.git
+cd django-deploy-toolkit
+pip install -e .
+```
+
+---
+
+## Quick Start
+
+```bash
+# Navigate to your Django project root (where manage.py lives)
+cd /path/to/your/django/project
+
+# Activate your project's virtual environment
+source venv/bin/activate
+
+# Run the setup
+django-deploy setup
+```
+
+That's it. The tool will:
+1. Auto-detect your project configuration
+2. Show you what it found and ask for confirmation
+3. Generate and install the config files
+4. Enable and start the services
+5. Test and reload Nginx
+
+---
+
+## What Gets Auto-Detected
+
+| Setting | Detection Method |
+|---------|-----------------|
+| **Project Name** | Basename of the current directory (sanitized) |
+| **Project Path** | Current working directory (searches for `manage.py`) |
+| **WSGI Module** | Parsed from `manage.py` → `DJANGO_SETTINGS_MODULE`, or scans for `wsgi.py` |
+| **User** | `$USER` env var → `$LOGNAME` → `pwd.getpwuid()` |
+| **Group** | Primary group of the detected user via `grp.getgrgid()` |
+| **Python Path** | `sys.executable` (virtualenv-aware) |
+| **Server IP** | `/etc/hosts` → `socket.gethostbyname()` → UDP socket trick → `_` (catch-all) |
+| **Workers** | `(2 × CPU cores) + 1`, capped at 9 (via `psutil`) |
+| **Static Root** | Parsed from `python manage.py diffsettings` output |
+| **Media Root** | Same as Static Root |
+
+---
+
+## Dry-Run Mode
+
+Preview everything that would happen without making any changes:
+
+```bash
+django-deploy setup --dry-run
+```
+
+Example output:
+
+```
+🚀 django-deploy-toolkit — Setup
+
+  [DRY RUN] Would write: /etc/systemd/system/myproject.socket
+  [DRY RUN] Would write: /etc/systemd/system/myproject.service
+  [DRY RUN] Would write: /etc/nginx/sites-available/myproject
+  [DRY RUN] Would remove: /etc/nginx/sites-enabled/default
+  [DRY RUN] Would remove: /etc/nginx/sites-available/default
+  [DRY RUN] Would create symlink: /etc/nginx/sites-enabled/myproject -> /etc/nginx/sites-available/myproject
+  [DRY RUN] Would run: systemctl daemon-reload
+  [DRY RUN] Would run: systemctl enable myproject.socket
+  [DRY RUN] Would run: systemctl start myproject.socket
+  [DRY RUN] Would run: systemctl enable myproject.service
+  [DRY RUN] Would run: nginx -t
+  [DRY RUN] Would run: systemctl reload nginx
+```
+
+---
+
+## Manual Overrides
+
+All CLI flags:
+
+```bash
+django-deploy setup [OPTIONS]
+
+Options:
+  --dry-run              Show what would be done without doing it
+  --project-path PATH    Override the detected project path
+  --project-name NAME    Override the detected project name
+  --no-confirm           Skip the confirmation prompt (for scripts/CI)
+  --verbose / --no-verbose  Show or hide detailed output
+  --version              Show version and exit
+  --help                 Show this message and exit
+```
+
+Other commands:
+
+```bash
+django-deploy detect             # Just run detection, no install
+django-deploy generate           # Generate files to current directory
+django-deploy generate --output-dir ./configs  # Generate to a specific directory
+django-deploy rollback --name myproject        # Rollback a previous install
+```
+
+---
+
+## Generated File Examples
+
+### Gunicorn Socket (`/etc/systemd/system/myproject.socket`)
+
+```ini
+[Unit]
+Description=gunicorn socket for myproject
+
+[Socket]
+ListenStream=/run/myproject.sock
+
+[Install]
+WantedBy=sockets.target
+```
+
+### Gunicorn Service (`/etc/systemd/system/myproject.service`)
+
+```ini
+[Unit]
+Description=gunicorn daemon for myproject
+Requires=myproject.socket
+After=network.target
+
+[Service]
+User=deploy
+Group=deploy
+WorkingDirectory=/home/deploy/myproject
+ExecStart=/home/deploy/myproject/venv/bin/python -m gunicorn \
+          --access-logfile - \
+          --workers 5 \
+          --bind unix:/run/myproject.sock \
+          myproject.wsgi:application
+
+[Install]
+WantedBy=multi-user.target
+```
+
+### Nginx Config (`/etc/nginx/sites-available/myproject`)
+
+```nginx
+server {
+    listen 80;
+    server_name 192.168.1.100;
+
+    location /static/ {
+        root /home/deploy/myproject;
+    }
+
+    location /media/ {
+        root /home/deploy/myproject;
+    }
+
+    location / {
+        include proxy_params;
+        proxy_pass http://unix:/run/myproject.sock;
+    }
+}
+```
+
+---
+
+## Default Nginx Config Removal
+
+During installation, `django-deploy-toolkit` removes the default Nginx configuration files:
+
+- `/etc/nginx/sites-enabled/default`
+- `/etc/nginx/sites-available/default`
+
+**Why?** The default Nginx config listens on port 80 and can conflict with your project's server block. Removing it ensures your Django project is the one handling requests.
+
+**Safety measures:**
+- Both files are backed up to a temporary directory before deletion
+- The tool warns you and pauses for 3 seconds before proceeding (press Ctrl+C to cancel)
+- If you skip if they don't exist — no error
+- During rollback, the backed-up files are restored to their original locations
+
+---
+
+## Rollback
+
+If any installation step fails, `django-deploy-toolkit` automatically rolls back all changes:
+
+1. Files created during the run are deleted
+2. Symlinks created during the run are removed
+3. The default Nginx config is restored from backup (if it was removed)
+4. Services that were started are stopped and disabled
+5. Systemd daemon is reloaded
+6. Nginx config is tested and reloaded
+
+You can also manually rollback a previous installation:
+
+```bash
+django-deploy rollback --name myproject
+```
+
+---
+
+## Contributing
+
+Contributions are welcome! Whether it's a bug fix, new feature, or documentation improvement — all help is appreciated.
+
+```bash
+# Clone the repository
+git clone https://github.com/antusaha970/django-deploy-toolkit.git
+cd django-deploy-toolkit
+
+# Install dev dependencies
+make install-dev
+
+# Run tests
+make test
+
+# Run tests with coverage
+make coverage
+```
+
+---
+
+## Credits
+
+- **Antu Saha** — Creator and lead maintainer
+- All open-source contributors — Thank you for helping make this project better! 🙏
+
+---
+
+## License
+
+MIT — see [LICENSE](LICENSE) for details.

django_deploy_toolkit-0.1.0/README.md

@@ -0,0 +1,267 @@
+# django-deploy-toolkit
+
+**Auto-generate and install Gunicorn & Nginx configuration for Django projects on Ubuntu/Debian.**
+
+`django-deploy-toolkit` detects your Django project's configuration, generates production-ready systemd service/socket files and Nginx server blocks, and installs them — all with a single command. It handles edge cases gracefully, supports dry-run mode, and includes full rollback on failure.
+
+---
+
+## Created By
+
+**Antu Saha** — creator and lead maintainer of this package.
+
+We also appreciate all the open-source contributors who help improve `django-deploy-toolkit`. Contributions of any kind are welcome — bug reports, feature requests, documentation improvements, and code contributions. See the [Contributing](#contributing) section below to get started.
+
+---
+
+## Requirements
+
+- **OS:** Ubuntu / Debian Linux
+- **Python:** 3.8 or higher
+- **Django project** with a `manage.py` file
+- **Gunicorn** installed in the project's virtual environment
+- **Nginx** installed on the server (`sudo apt install nginx`)
+- **systemd** available (standard on Ubuntu/Debian)
+
+---
+
+## Installation
+
+```bash
+pip install django-deploy-toolkit
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/antusaha970/django-deploy-toolkit.git
+cd django-deploy-toolkit
+pip install -e .
+```
+
+---
+
+## Quick Start
+
+```bash
+# Navigate to your Django project root (where manage.py lives)
+cd /path/to/your/django/project
+
+# Activate your project's virtual environment
+source venv/bin/activate
+
+# Run the setup
+django-deploy setup
+```
+
+That's it. The tool will:
+1. Auto-detect your project configuration
+2. Show you what it found and ask for confirmation
+3. Generate and install the config files
+4. Enable and start the services
+5. Test and reload Nginx
+
+---
+
+## What Gets Auto-Detected
+
+| Setting | Detection Method |
+|---------|-----------------|
+| **Project Name** | Basename of the current directory (sanitized) |
+| **Project Path** | Current working directory (searches for `manage.py`) |
+| **WSGI Module** | Parsed from `manage.py` → `DJANGO_SETTINGS_MODULE`, or scans for `wsgi.py` |
+| **User** | `$USER` env var → `$LOGNAME` → `pwd.getpwuid()` |
+| **Group** | Primary group of the detected user via `grp.getgrgid()` |
+| **Python Path** | `sys.executable` (virtualenv-aware) |
+| **Server IP** | `/etc/hosts` → `socket.gethostbyname()` → UDP socket trick → `_` (catch-all) |
+| **Workers** | `(2 × CPU cores) + 1`, capped at 9 (via `psutil`) |
+| **Static Root** | Parsed from `python manage.py diffsettings` output |
+| **Media Root** | Same as Static Root |
+
+---
+
+## Dry-Run Mode
+
+Preview everything that would happen without making any changes:
+
+```bash
+django-deploy setup --dry-run
+```
+
+Example output:
+
+```
+🚀 django-deploy-toolkit — Setup
+
+  [DRY RUN] Would write: /etc/systemd/system/myproject.socket
+  [DRY RUN] Would write: /etc/systemd/system/myproject.service
+  [DRY RUN] Would write: /etc/nginx/sites-available/myproject
+  [DRY RUN] Would remove: /etc/nginx/sites-enabled/default
+  [DRY RUN] Would remove: /etc/nginx/sites-available/default
+  [DRY RUN] Would create symlink: /etc/nginx/sites-enabled/myproject -> /etc/nginx/sites-available/myproject
+  [DRY RUN] Would run: systemctl daemon-reload
+  [DRY RUN] Would run: systemctl enable myproject.socket
+  [DRY RUN] Would run: systemctl start myproject.socket
+  [DRY RUN] Would run: systemctl enable myproject.service
+  [DRY RUN] Would run: nginx -t
+  [DRY RUN] Would run: systemctl reload nginx
+```
+
+---
+
+## Manual Overrides
+
+All CLI flags:
+
+```bash
+django-deploy setup [OPTIONS]
+
+Options:
+  --dry-run              Show what would be done without doing it
+  --project-path PATH    Override the detected project path
+  --project-name NAME    Override the detected project name
+  --no-confirm           Skip the confirmation prompt (for scripts/CI)
+  --verbose / --no-verbose  Show or hide detailed output
+  --version              Show version and exit
+  --help                 Show this message and exit
+```
+
+Other commands:
+
+```bash
+django-deploy detect             # Just run detection, no install
+django-deploy generate           # Generate files to current directory
+django-deploy generate --output-dir ./configs  # Generate to a specific directory
+django-deploy rollback --name myproject        # Rollback a previous install
+```
+
+---
+
+## Generated File Examples
+
+### Gunicorn Socket (`/etc/systemd/system/myproject.socket`)
+
+```ini
+[Unit]
+Description=gunicorn socket for myproject
+
+[Socket]
+ListenStream=/run/myproject.sock
+
+[Install]
+WantedBy=sockets.target
+```
+
+### Gunicorn Service (`/etc/systemd/system/myproject.service`)
+
+```ini
+[Unit]
+Description=gunicorn daemon for myproject
+Requires=myproject.socket
+After=network.target
+
+[Service]
+User=deploy
+Group=deploy
+WorkingDirectory=/home/deploy/myproject
+ExecStart=/home/deploy/myproject/venv/bin/python -m gunicorn \
+          --access-logfile - \
+          --workers 5 \
+          --bind unix:/run/myproject.sock \
+          myproject.wsgi:application
+
+[Install]
+WantedBy=multi-user.target
+```
+
+### Nginx Config (`/etc/nginx/sites-available/myproject`)
+
+```nginx
+server {
+    listen 80;
+    server_name 192.168.1.100;
+
+    location /static/ {
+        root /home/deploy/myproject;
+    }
+
+    location /media/ {
+        root /home/deploy/myproject;
+    }
+
+    location / {
+        include proxy_params;
+        proxy_pass http://unix:/run/myproject.sock;
+    }
+}
+```
+
+---
+
+## Default Nginx Config Removal
+
+During installation, `django-deploy-toolkit` removes the default Nginx configuration files:
+
+- `/etc/nginx/sites-enabled/default`
+- `/etc/nginx/sites-available/default`
+
+**Why?** The default Nginx config listens on port 80 and can conflict with your project's server block. Removing it ensures your Django project is the one handling requests.
+
+**Safety measures:**
+- Both files are backed up to a temporary directory before deletion
+- The tool warns you and pauses for 3 seconds before proceeding (press Ctrl+C to cancel)
+- If you skip if they don't exist — no error
+- During rollback, the backed-up files are restored to their original locations
+
+---
+
+## Rollback
+
+If any installation step fails, `django-deploy-toolkit` automatically rolls back all changes:
+
+1. Files created during the run are deleted
+2. Symlinks created during the run are removed
+3. The default Nginx config is restored from backup (if it was removed)
+4. Services that were started are stopped and disabled
+5. Systemd daemon is reloaded
+6. Nginx config is tested and reloaded
+
+You can also manually rollback a previous installation:
+
+```bash
+django-deploy rollback --name myproject
+```
+
+---
+
+## Contributing
+
+Contributions are welcome! Whether it's a bug fix, new feature, or documentation improvement — all help is appreciated.
+
+```bash
+# Clone the repository
+git clone https://github.com/antusaha970/django-deploy-toolkit.git
+cd django-deploy-toolkit
+
+# Install dev dependencies
+make install-dev
+
+# Run tests
+make test
+
+# Run tests with coverage
+make coverage
+```
+
+---
+
+## Credits
+
+- **Antu Saha** — Creator and lead maintainer
+- All open-source contributors — Thank you for helping make this project better! 🙏
+
+---
+
+## License
+
+MIT — see [LICENSE](LICENSE) for details.

django_deploy_toolkit-0.1.0/django_deploy_toolkit/__init__.py

@@ -0,0 +1,4 @@
+"""django-deploy-toolkit: Auto-generate Gunicorn & Nginx configs for Django projects."""
+
+__version__ = "0.1.0"
+__author__ = "Antu Saha"