Documentation

Django Revolution

v1.0.13

Installation Guide - Django Revolution

Quick Install (Recommended)

# Using pip
pip install django-revolution


# Using poetry
poetry add django-revolution


# Using requirements.txt
echo "django-revolution>=1.0.13" >> requirements.txt
pip install -r requirements.txt

Django Integration

# settings.py
INSTALLED_APPS = [
    'django_revolution',
    # your existing apps
]

Verification

# Check status
python manage.py revolution --status


# Or use standalone CLI
django-revolution --status

Development Installation

From Source

# Clone repository
git clone https://github.com/markolofsen/django-revolution.git
cd django-revolution


# Install in development mode
pip install -e .


# Install development dependencies
pip install -r requirements-dev.txt


# Test installation
python scripts/dev_cli.py

With Poetry

# Add to project
poetry add django-revolution


# Add development dependencies
poetry add --group dev django-revolution[dev]

System Requirements

Minimum Requirements

  • Python 3.9+
  • Django 3.2+
  • 100MB free disk space
  • Internet connection (for dependency installation)

Recommended

  • Python 3.11+
  • Django 4.2+
  • Node.js 18+ (for TypeScript generation)
  • Poetry (for dependency management)

Dependencies

Auto-Installed Dependencies

Automatically installed when needed:

  • @hey-api/openapi-ts - TypeScript client generation
  • datamodel-code-generator - Python client generation
  • drf-spectacular - OpenAPI schema generation

Pre-Installed Dependencies

Included with package:

  • Django>=3.2 - Web framework
  • djangorestframework>=3.12.0 - API framework
  • drf-spectacular>=0.24.0 - OpenAPI schema generation
  • Jinja2>=3.0.0 - Template engine
  • PyYAML>=6.0 - YAML processing
  • pydantic>=2.0.0 - Data validation
  • pydantic-settings>=2.0.0 - Settings management
  • questionary>=2.0.0 - Interactive CLI
  • rich>=13.0.0 - Rich terminal output
  • datamodel-code-generator>=0.31.0 - Python client generation
  • django-filter>=22.0.0 - Filtering support
  • djangorestframework-simplejwt>=5.0.0 - JWT authentication

Basic Configuration

# settings.py
from django_revolution.app_config import ZoneConfig, get_revolution_config


# Define zones
zones = {
    'public': ZoneConfig(
        apps=['accounts', 'billing', 'payments'],
        title='Public API',
        description='API for public client applications',
        public=True,
        auth_required=False,
        version='v1'
    ),
    'admin': ZoneConfig(
        apps=['admin_panel', 'services'],
        title='Admin API',
        description='Administrative API endpoints',
        public=False,
        auth_required=True,
        version='v1'
    )
}


# Configure Django Revolution
DJANGO_REVOLUTION = get_revolution_config(
    project_root=BASE_DIR,
    zones=zones,
    debug=DEBUG
)

Multi-Monorepo Configuration

# settings.py - With multiple monorepo configurations
from django_revolution.app_config import MonorepoConfig, MonorepoSettings


# Configure multiple monorepos
monorepo_settings = MonorepoSettings(
    enabled=True,
    configurations=[
        # Main frontend monorepo
        MonorepoConfig(
            name="frontend",
            enabled=True,
            path=str(BASE_DIR.parent / 'monorepo'),
            api_package_path='packages/api'
        ),
        # Mobile app monorepo
        MonorepoConfig(
            name="mobile",
            enabled=True,
            path=str(BASE_DIR.parent / 'mobile-monorepo'),
            api_package_path='packages/api-client'
        ),
    ]
)


DJANGO_REVOLUTION = get_revolution_config(
    project_root=BASE_DIR,
    zones=zones,
    monorepo=monorepo_settings,
    debug=DEBUG
)

URL Integration

# urls.py
from django_revolution.urls_integration import add_revolution_urls


urlpatterns = [
    # Your existing URLs
]


# Add Django Revolution URLs
urlpatterns = add_revolution_urls(urlpatterns)

Optional Settings

# settings.py (optional customization)
DJANGO_REVOLUTION = {
    'output_dir': 'openapi',           # Default: 'openapi'
    'auto_install_deps': True,         # Default: True
    'typescript_enabled': True,        # Default: True
    'python_enabled': True,            # Default: True
    'archive_clients': True,           # Default: True
    'monorepo': {                      # Optional monorepo config
        'enabled': False,
        'path': '/path/to/monorepo',
        'api_package_path': 'packages/api/src'
    }
}

Environment Variables

# Skip auto-installation of dependencies
export DJANGO_REVOLUTION_NO_AUTO_INSTALL=1


# Custom output directory
export DJANGO_REVOLUTION_OUTPUT_DIR=/custom/path


# Debug mode
export DJANGO_REVOLUTION_DEBUG=1

Troubleshooting

Common Installation Issues

ImportError: No module named 'django_revolution'

# Install Django Revolution
pip install django-revolution


# Verify installation
python -c "import django_revolution; print('✅ Installed')"


# Check version
python -c "import django_revolution; print(django_revolution.__version__)"

ModuleNotFoundError: No module named 'django_filters'

# Install missing dependencies
pip install django-filter djangorestframework-simplejwt


# Or let Django Revolution install them
python manage.py revolution --install-deps


# Or install from requirements
pip install -r requirements.txt

Node.js Requirements

# Ubuntu/Debian
curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt-get install -y nodejs


# macOS with Homebrew
brew install node


# Windows with Chocolatey
choco install nodejs

Permission Issues

# Fix npm permissions (Linux/macOS)
sudo chown -R $(whoami) ~/.npm


# Make scripts executable
chmod +x scripts/*.py scripts/*.sh

Next: Usage Guide · Troubleshooting