Django Migrations

🚀 Django Migration MCP Service

The Django Migration MCP (Migration Control Panel) service is a tool for managing database migrations in Django projects. It offers a complete API and console interface to simplify the database migration process.

🚀 Quick Start

The Django Migration MCP service is designed to streamline the database migration process for Django projects. It provides a unified way to manage migrations through a simple HTTP interface and offers various features for automation, logging, and extensibility.

✨ Features

• Unified Control Panel: Manage all migration operations through a simple HTTP interface.
• Automated Workflow: Automatically detect and execute pending migrations.
• Logging and Tracking: Keep detailed records of each operation and its results for easy debugging and auditing.
• Scalability: Support custom commands and plugins.

📦 Installation

Development Environment

# Clone the repository
git clone git@github.com:your-repository.git
cd django-migration-mcp

# Create a virtual environment and install dependencies
python -m venv env
source env/bin/activate  # Use .\env\Scripts\activate on Windows
pip install -r requirements.txt

Production Environment

# Install the service (assuming the repository has been cloned)
sudo systemctl enable simple_http_server
sudo systemctl start simple_http_server

💻 Usage Examples

Django Project Configuration

Add the following configuration to the settings.py file in your Django project:

MIGRATION_MCP_ENABLED = True
MIGRATION_MCP_URL = 'http://localhost:8000'  # Modify according to your actual situation

Command-Line Tools

You can use the MCP service directly from the command line:

# View help information
python manage.py migration_mcp --help

# Execute all pending migrations
python manage.py migrate_all

# Execute migrations for a specific app
python manage.py migrate app_name

# Roll back the last migration
python manage.py rollback

# Show the current database status
python manage.py show_migrations

📚 Documentation

Request Format

All requests should be sent via the POST method to the /mcp endpoint and include a JSON-formatted body:

{
    "method": "Method Name",
    "params": {
        "Parameter 1": Value,
        "Parameter 2": Value
    }
}

Specific Interfaces

1. List All Migrations

curl -X POST http://localhost:8000/mcp \
  -H "Content-Type: application/json" \
  -d '{"method": "list_migrations"}'

2. Execute Migrations for a Specific App

curl -X POST http://localhost:8000/mcp \
  -H "Content-Type: application/json" \
  -d '{"method": "migrate", "params": {"app": "your_app"}}'

3. Roll Back Migrations for a Specific App

curl -X POST http://localhost:8000/mcp \
  -H "Content-Type: application/json" \
  -d '{"method": "rollback", "params": {"app": "your_app"}}'

🔧 Technical Details

Redis Integration

By integrating Redis, you can achieve more efficient migration management and status tracking.

Logging System

The built-in logging module helps developers quickly locate issues. Log files are stored in the mcp_logs/ directory by default.

Security Measures

• Authentication: Support basic authentication and Token authentication.
• Permission Control: Set different operation permissions for different users.

Docker Usage Guide

Quick Start

docker run -d --name django-migration-mcp \
  -e DJANGO_SETTINGS_MODULE=your_project.settings \
  -p 8000:8000 \
  your-django-mcp-image

Enter the Interactive Environment

docker exec -it django-migration-mcp /bin/bash

Network Configuration

Create a Network

docker network create mcp-network

Connect to the Network

docker network connect mcp-network your-container-name

Monitoring and Maintenance

Log Monitoring

docker logs -f django-migration-mcp

Automatic Restart Policy

Add a restart policy to the startup command:

docker run --restart unless-stopped ...

FAQ

1. How to handle migration conflicts?
   • Enable the conflict detection feature in settings.py.
2. How to execute migrations for multiple apps in batches?
   • Use the migrate_all command or make batch calls through the API.
3. How to view migration history?
   • Use the show_migrations command or query the log files.

Contribution Guidelines

We welcome contributions from the community! Please fork the repository and indicate your changes in the Pull Request.

📄 License

This project is licensed under the MIT License.