djaploy 0.1.0__tar.gz

djaploy-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 djaploy 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.

djaploy-0.1.0/PKG-INFO

@@ -0,0 +1,310 @@
+Metadata-Version: 2.4
+Name: djaploy
+Version: 0.1.0
+Summary: Modular Django deployment system based on pyinfra
+Author-email: Johanna Mae Dimayuga <johanna@techco.fi>
+License: MIT License
+        
+        Copyright (c) 2024 djaploy 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.
+Project-URL: Homepage, https://github.com/techco-fi/djaploy
+Project-URL: Repository, https://github.com/techco-fi/djaploy
+Project-URL: Issues, https://github.com/techco-fi/djaploy/issues
+Project-URL: Documentation, https://github.com/techco-fi/djaploy#readme
+Keywords: django,deployment,pyinfra,automation,infrastructure
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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 :: Software Development :: Build Tools
+Classifier: Topic :: System :: Installation/Setup
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyinfra>=3.4
+Requires-Dist: django>=3.2
+Requires-Dist: build<2.0.0,>=1.3.0
+Provides-Extra: certificates
+Requires-Dist: certbot>=2.0; extra == "certificates"
+Provides-Extra: bunny
+Requires-Dist: certbot-dns-bunny>=0.1.0; extra == "bunny"
+Dynamic: license-file
+
+# djaploy
+
+A modular Django deployment system based on pyinfra, designed to standardize and simplify infrastructure management across Django projects.
+
+## Features
+
+- **Modular Architecture**: Extensible plugin system for deployment components
+- **Django Integration**: Seamless integration via Django management commands  
+- **Python Compilation Support**: Compile Python from source for specific versions
+- **Multiple Deployment Modes**: Support for `--local`, `--latest`, and `--release` deployments
+- **Infrastructure as Code**: Define infrastructure using Python with pyinfra
+- **Git-based Artifacts**: Automated artifact creation from git repository
+
+## Installation
+
+### From PyPI (once published)
+
+```bash
+pip install djaploy
+```
+
+Or with Poetry:
+```bash
+poetry add djaploy
+```
+
+### Development Installation
+
+For testing djaploy locally without publishing to PyPI:
+
+```bash
+# Clone the repository
+git clone https://github.com/techco-fi/djaploy.git
+cd djaploy
+
+# Install in editable mode
+pip install -e .
+
+# Or with Poetry  
+poetry install
+```
+
+Then in your Django project:
+```bash
+# Using pip
+pip install -e /path/to/djaploy
+
+# Or add as a local dependency in pyproject.toml
+[tool.poetry.dependencies]
+djaploy = {path = "../djaploy", develop = true}
+```
+
+## Quick Start
+
+### 1. Project Structure
+
+```
+your-django-project/
+├── manage.py
+├── your_app/
+│   └── settings.py
+└── djaploy/                    # Deployment configuration
+    ├── config.py              # Main configuration
+    ├── inventory/             # Host definitions
+    │   ├── production.py
+    │   └── staging.py  
+    └── deploy_files/          # Environment-specific files
+        ├── production/
+        │   └── etc/systemd/system/app.service
+        └── staging/
+```
+
+### 2. Django Settings
+
+Add to your Django `settings.py`:
+
+```python
+# Required: Set project paths
+BASE_DIR = '/path/to/django'  
+PROJECT_DIR = BASE_DIR # folder containing manage.py
+DJAPLOY_CONFIG_DIR = BASE_DIR + '/djaploy'
+GIT_DIR = BASE_DIR.parent  # Git repository root
+```
+
+### 3. Create Configuration
+
+Create `djaploy/config.py`:
+
+```python
+from djaploy.config import DjaployConfig
+from pathlib import Path
+
+config = DjaployConfig(
+    # Required fields
+    project_name="myapp",
+    djaploy_dir=Path(__file__).parent,  # REQUIRED: This djaploy directory
+    manage_py_path=Path("manage.py"),   # REQUIRED: Path to manage.py (relative to project root)
+    
+    # Python settings
+    python_version="3.11",
+    python_compile=False,  # Set True to compile from source
+    
+    # Server settings
+    app_user="app",
+    ssh_user="deploy",
+    
+    # Modules to use
+    modules=[
+        "djaploy.modules.core",      # Core setup (required)
+        "djaploy.modules.nginx",     # Web server
+        "djaploy.modules.systemd",   # Service management
+    ],
+    
+    # Services to manage
+    services=["myapp", "myapp-worker"],
+)
+```
+
+### 4. Define Inventory
+
+Create `djaploy/inventory/production.py`:
+
+```python
+from djaploy.config import HostConfig
+
+hosts = [
+    HostConfig(
+        name="web-1",
+        ssh_host="192.168.1.100",
+        ssh_user="deploy",
+        app_user="app",
+        env="production",
+        services=["myapp", "myapp-worker"],
+    ),
+]
+```
+
+### 5. Deploy Files
+
+Place service files in `djaploy/deploy_files/production/`:
+
+```ini
+# etc/systemd/system/myapp.service
+[Unit]
+Description=My Django App
+After=network.target
+
+[Service]
+Type=simple
+User=app
+WorkingDirectory=/home/app/apps/myapp
+ExecStart=/home/app/.local/bin/poetry run gunicorn config.wsgi
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target
+```
+
+## Usage
+
+### Configure Server
+
+```bash
+python manage.py configureserver --env production
+```
+
+This will:
+- Create application user
+- Install/compile Python  
+- Install Poetry
+- Set up directory structure
+
+### Deploy Application
+
+```bash
+# Deploy local changes (for development)
+python manage.py deploy --env production --local
+
+# Deploy latest git commit
+python manage.py deploy --env production --latest
+
+# Deploy specific release
+python manage.py deploy --env production --release v1.0.0
+```
+
+Deployment process:
+1. Creates tar.gz artifact from git
+2. Uploads to servers
+3. Extracts application code
+4. Installs dependencies
+5. Runs migrations
+6. Collects static files  
+7. Restarts services
+
+## Module System
+
+Djaploy uses a modular architecture where each component (nginx, systemd, backups, etc.) is a separate module that can be enabled or disabled per project.
+
+### Available Modules
+
+- `nginx`: NGINX web server configuration
+- `systemd`: Systemd service management
+- `litestream`: Litestream database backups
+- `rclone`: Rclone-based backup system
+- `tailscale`: Tailscale networking
+- `ssl`: SSL certificate management
+- `python_build`: Python compilation from source
+
+### Creating Custom Modules
+
+Projects can create their own modules by extending the base module class:
+
+```python
+from djaploy.modules.base import BaseModule
+
+class MyCustomModule(BaseModule):
+    def configure_server(self, host):
+        # Server configuration logic
+        pass
+    
+    def deploy(self, host, artifact_path):
+        # Deployment logic
+        pass
+```
+
+## Project Customization
+
+### prepare.py
+
+Projects can include a `prepare.py` file for local build steps before deployment:
+
+```python
+# prepare.py
+from djaploy.prepare import run_command
+
+def prepare():
+    run_command("npm run build")
+    run_command("python manage.py collectstatic --noinput")
+```
+
+### Custom Deploy Files
+
+Projects can include environment-specific configuration files in a `deploy_files/` directory that will be copied to the server during deployment.
+
+## License
+
+MIT

djaploy-0.1.0/README.md

@@ -0,0 +1,247 @@
+# djaploy
+
+A modular Django deployment system based on pyinfra, designed to standardize and simplify infrastructure management across Django projects.
+
+## Features
+
+- **Modular Architecture**: Extensible plugin system for deployment components
+- **Django Integration**: Seamless integration via Django management commands  
+- **Python Compilation Support**: Compile Python from source for specific versions
+- **Multiple Deployment Modes**: Support for `--local`, `--latest`, and `--release` deployments
+- **Infrastructure as Code**: Define infrastructure using Python with pyinfra
+- **Git-based Artifacts**: Automated artifact creation from git repository
+
+## Installation
+
+### From PyPI (once published)
+
+```bash
+pip install djaploy
+```
+
+Or with Poetry:
+```bash
+poetry add djaploy
+```
+
+### Development Installation
+
+For testing djaploy locally without publishing to PyPI:
+
+```bash
+# Clone the repository
+git clone https://github.com/techco-fi/djaploy.git
+cd djaploy
+
+# Install in editable mode
+pip install -e .
+
+# Or with Poetry  
+poetry install
+```
+
+Then in your Django project:
+```bash
+# Using pip
+pip install -e /path/to/djaploy
+
+# Or add as a local dependency in pyproject.toml
+[tool.poetry.dependencies]
+djaploy = {path = "../djaploy", develop = true}
+```
+
+## Quick Start
+
+### 1. Project Structure
+
+```
+your-django-project/
+├── manage.py
+├── your_app/
+│   └── settings.py
+└── djaploy/                    # Deployment configuration
+    ├── config.py              # Main configuration
+    ├── inventory/             # Host definitions
+    │   ├── production.py
+    │   └── staging.py  
+    └── deploy_files/          # Environment-specific files
+        ├── production/
+        │   └── etc/systemd/system/app.service
+        └── staging/
+```
+
+### 2. Django Settings
+
+Add to your Django `settings.py`:
+
+```python
+# Required: Set project paths
+BASE_DIR = '/path/to/django'  
+PROJECT_DIR = BASE_DIR # folder containing manage.py
+DJAPLOY_CONFIG_DIR = BASE_DIR + '/djaploy'
+GIT_DIR = BASE_DIR.parent  # Git repository root
+```
+
+### 3. Create Configuration
+
+Create `djaploy/config.py`:
+
+```python
+from djaploy.config import DjaployConfig
+from pathlib import Path
+
+config = DjaployConfig(
+    # Required fields
+    project_name="myapp",
+    djaploy_dir=Path(__file__).parent,  # REQUIRED: This djaploy directory
+    manage_py_path=Path("manage.py"),   # REQUIRED: Path to manage.py (relative to project root)
+    
+    # Python settings
+    python_version="3.11",
+    python_compile=False,  # Set True to compile from source
+    
+    # Server settings
+    app_user="app",
+    ssh_user="deploy",
+    
+    # Modules to use
+    modules=[
+        "djaploy.modules.core",      # Core setup (required)
+        "djaploy.modules.nginx",     # Web server
+        "djaploy.modules.systemd",   # Service management
+    ],
+    
+    # Services to manage
+    services=["myapp", "myapp-worker"],
+)
+```
+
+### 4. Define Inventory
+
+Create `djaploy/inventory/production.py`:
+
+```python
+from djaploy.config import HostConfig
+
+hosts = [
+    HostConfig(
+        name="web-1",
+        ssh_host="192.168.1.100",
+        ssh_user="deploy",
+        app_user="app",
+        env="production",
+        services=["myapp", "myapp-worker"],
+    ),
+]
+```
+
+### 5. Deploy Files
+
+Place service files in `djaploy/deploy_files/production/`:
+
+```ini
+# etc/systemd/system/myapp.service
+[Unit]
+Description=My Django App
+After=network.target
+
+[Service]
+Type=simple
+User=app
+WorkingDirectory=/home/app/apps/myapp
+ExecStart=/home/app/.local/bin/poetry run gunicorn config.wsgi
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target
+```
+
+## Usage
+
+### Configure Server
+
+```bash
+python manage.py configureserver --env production
+```
+
+This will:
+- Create application user
+- Install/compile Python  
+- Install Poetry
+- Set up directory structure
+
+### Deploy Application
+
+```bash
+# Deploy local changes (for development)
+python manage.py deploy --env production --local
+
+# Deploy latest git commit
+python manage.py deploy --env production --latest
+
+# Deploy specific release
+python manage.py deploy --env production --release v1.0.0
+```
+
+Deployment process:
+1. Creates tar.gz artifact from git
+2. Uploads to servers
+3. Extracts application code
+4. Installs dependencies
+5. Runs migrations
+6. Collects static files  
+7. Restarts services
+
+## Module System
+
+Djaploy uses a modular architecture where each component (nginx, systemd, backups, etc.) is a separate module that can be enabled or disabled per project.
+
+### Available Modules
+
+- `nginx`: NGINX web server configuration
+- `systemd`: Systemd service management
+- `litestream`: Litestream database backups
+- `rclone`: Rclone-based backup system
+- `tailscale`: Tailscale networking
+- `ssl`: SSL certificate management
+- `python_build`: Python compilation from source
+
+### Creating Custom Modules
+
+Projects can create their own modules by extending the base module class:
+
+```python
+from djaploy.modules.base import BaseModule
+
+class MyCustomModule(BaseModule):
+    def configure_server(self, host):
+        # Server configuration logic
+        pass
+    
+    def deploy(self, host, artifact_path):
+        # Deployment logic
+        pass
+```
+
+## Project Customization
+
+### prepare.py
+
+Projects can include a `prepare.py` file for local build steps before deployment:
+
+```python
+# prepare.py
+from djaploy.prepare import run_command
+
+def prepare():
+    run_command("npm run build")
+    run_command("python manage.py collectstatic --noinput")
+```
+
+### Custom Deploy Files
+
+Projects can include environment-specific configuration files in a `deploy_files/` directory that will be copied to the server during deployment.
+
+## License
+
+MIT

djaploy-0.1.0/djaploy/__init__.py

@@ -0,0 +1,14 @@
+"""
+djaploy - Modular Django deployment system based on pyinfra
+"""
+
+from .config import DjaployConfig
+from .deploy import deploy_project, configure_server
+from .version import __version__
+
+__all__ = [
+    "DjaployConfig",
+    "deploy_project", 
+    "configure_server",
+    "__version__",
+]

djaploy-0.1.0/djaploy/artifact.py

@@ -0,0 +1,124 @@
+"""
+Artifact creation for deployments
+"""
+
+import os
+import subprocess
+import tempfile
+from pathlib import Path
+from typing import Optional
+
+from .config import DjaployConfig
+
+
+def create_artifact(config: DjaployConfig, 
+                   mode: str = "latest",
+                   release_tag: Optional[str] = None) -> Path:
+    """
+    Create deployment artifact based on mode
+    
+    Args:
+        config: DjaployConfig instance
+        mode: Deployment mode ("local", "latest", "release")
+        release_tag: Release tag if mode is "release"
+        
+    Returns:
+        Path to created artifact
+    """
+    
+    # Ensure artifact directory exists
+    artifact_dir = config.git_dir / config.artifact_dir
+    artifact_dir.mkdir(parents=True, exist_ok=True)
+    
+    if mode == "local":
+        return _create_local_artifact(config, artifact_dir)
+    elif mode == "latest":
+        return _create_latest_artifact(config, artifact_dir)
+    elif mode == "release":
+        if not release_tag:
+            raise ValueError("release_tag is required when mode is 'release'")
+        return _create_release_artifact(config, artifact_dir, release_tag)
+    else:
+        raise ValueError(f"Invalid deployment mode: {mode}")
+
+
+def _create_local_artifact(config: DjaployConfig, artifact_dir: Path) -> Path:
+    """Create artifact from local uncommitted files"""
+    
+    artifact_file = artifact_dir / f"{config.project_name}.local.tar.gz"
+    
+    # Change to git directory
+    original_dir = os.getcwd()
+    os.chdir(config.git_dir)
+    
+    try:
+        # Create artifact from git files (including uncommitted changes)
+        subprocess.run(
+            "git ls-files --others --exclude-standard --cached | tar Tzcf - {}".format(artifact_file),
+            shell=True,
+            check=True,
+        )
+        
+        return artifact_file
+    finally:
+        os.chdir(original_dir)
+
+
+def _create_latest_artifact(config: DjaployConfig, artifact_dir: Path) -> Path:
+    """Create artifact from latest git commit"""
+    
+    # Get git hash
+    git_hash = subprocess.run(
+        ["git", "rev-parse", "--short", "HEAD"],
+        capture_output=True,
+        check=True,
+        text=True,
+        cwd=config.git_dir,
+    ).stdout.strip()
+    
+    return _create_git_artifact(config, artifact_dir, git_hash)
+
+
+def _create_release_artifact(config: DjaployConfig, artifact_dir: Path, release_tag: str) -> Path:
+    """Create artifact from a specific release tag"""
+    
+    # Verify the tag exists
+    try:
+        subprocess.run(
+            ["git", "rev-parse", release_tag],
+            capture_output=True,
+            check=True,
+            cwd=config.git_dir,
+        )
+    except subprocess.CalledProcessError:
+        raise ValueError(f"Release tag '{release_tag}' does not exist")
+    
+    return _create_git_artifact(config, artifact_dir, release_tag)
+
+
+def _create_git_artifact(config: DjaployConfig, artifact_dir: Path, git_ref: str) -> Path:
+    """Create artifact from a git reference"""
+    
+    artifact_tar = artifact_dir / f"{config.project_name}.{git_ref}.tar"
+    artifact_file = artifact_dir / f"{config.project_name}.{git_ref}.tar.gz"
+    
+    # Change to git directory
+    original_dir = os.getcwd()
+    os.chdir(config.git_dir)
+    
+    try:
+        # Create tar archive from git
+        subprocess.run(
+            ["git", "archive", "--format=tar", "-o", str(artifact_tar), git_ref],
+            check=True,
+        )
+        
+        # Compress the tar file
+        subprocess.run(
+            ["gzip", "-f", str(artifact_tar)],
+            check=True,
+        )
+        
+        return artifact_file
+    finally:
+        os.chdir(original_dir)