Integrating JSON Import into Django Admin

You can integrate your JSON import functionality into the Django Admin interface by creating a custom admin action or a custom admin view. Here are two approaches:

Option 1: Custom Admin Action with File Upload

This approach adds a custom action to your model's admin page that allows you to upload and process a JSON file:

PYTHONCopied
# yourapp/admin.py
from django.contrib import admin
from django.http import HttpResponseRedirect
from django.template.response import TemplateResponse
from django.urls import path
from django import forms
import json

from .models import YourModel

class JsonImportForm(forms.Form):
    json_file = forms.FileField()

class YourModelAdmin(admin.ModelAdmin):
    list_display = ['title', 'other_field']  # Customize as needed
    actions = ['import_json']
    
    def get_urls(self):
        urls = super().get_urls()
        custom_urls = [
            path('import-json/', self.admin_site.admin_view(self.import_json_view), name='import-json'),
        ]
        return custom_urls + urls
    
    def import_json(self, request, queryset):
        # Redirect to the custom import view
        return HttpResponseRedirect("../import-json/")
    import_json.short_description = "Import data from JSON file"
    
    def import_json_view(self, request):
        context = {
            'title': 'Import JSON Data',
            'opts': self.model._meta,
            'app_label': self.model._meta.app_label,
        }
        
        if request.method == 'POST':
            form = JsonImportForm(request.POST, request.FILES)
            if form.is_valid():
                json_file = request.FILES['json_file']
                json_data = json.loads(json_file.read().decode('utf-8'))
                
                # Process your JSON data
                updated_count = 0
                created_count = 0
                
                for item in json_data:
                    # Assuming 'title' is your unique identifier
                    title = item.get('title')
                    if title:
                        # Try to find existing instance
                        instance, created = YourModel.objects.get_or_create(
                            title=title,
                            defaults=item  # Use all data for new instances
                        )
                        
                        if not created:
                            # Update existing instance with new data
                            for key, value in item.items():
                                setattr(instance, key, value)
                            instance.save()
                            updated_count += 1
                        else:
                            created_count += 1
                
                self.message_user(
                    request, 
                    f"Successfully imported JSON data: {created_count} created, {updated_count} updated."
                )
                return HttpResponseRedirect("../")
        else:
            form = JsonImportForm()
        
        context['form'] = form
        return TemplateResponse(request, "admin/import_json.html", context)

admin.site.register(YourModel, YourModelAdmin)

You'll need to create a template for the import form:

HTMLCopied
<!-- templates/admin/import_json.html -->
{% extends "admin/base_site.html" %}
{% load i18n admin_urls %}

{% block content %}
<div id="content-main">
    <form method="post" enctype="multipart/form-data">
        {% csrf_token %}
        <fieldset class="module aligned">
            {% for field in form %}
                <div class="form-row">
                    <div>
                        {{ field.errors }}
                        {{ field.label_tag }}
                        {{ field }}
                    </div>
                </div>
            {% endfor %}
        </fieldset>
        <div class="submit-row">
            <input type="submit" class="default" value="Import JSON">
        </div>
    </form>
</div>
{% endblock %}

Option 2: Custom Admin Button in Change List

This approach adds a custom button to the top of your model's change list page:

PYTHONCopied
# yourapp/admin.py
from django.contrib import admin
from django.urls import path
from django.template.response import TemplateResponse
from django.http import HttpResponseRedirect
from django import forms
import json

from .models import YourModel

class JsonImportForm(forms.Form):
    json_file = forms.FileField()

class YourModelAdmin(admin.ModelAdmin):
    change_list_template = 'admin/yourapp/yourmodel/change_list.html'
    
    def get_urls(self):
        urls = super().get_urls()
        custom_urls = [
            path('import-json/', self.admin_site.admin_view(self.import_json_view), name='import-json'),
        ]
        return custom_urls + urls
    
    def import_json_view(self, request):
        # Same implementation as in Option 1
        # ...

admin.site.register(YourModel, YourModelAdmin)

Create a custom change list template:

HTMLCopied
<!-- templates/admin/yourapp/yourmodel/change_list.html -->
{% extends "admin/change_list.html" %}
{% load i18n admin_urls %}

{% block object-tools-items %}
    <li>
        <a href="{% url 'admin:import-json' %}" class="addlink">
            {% trans 'Import JSON' %}
        </a>
    </li>
    {{ block.super }}
{% endblock %}

Processing Logic

For both options, the core processing logic is similar:

1. Read the uploaded JSON file
2. For each item in the JSON:
   • Check if an instance with the matching key (e.g., title) exists
   • If it exists, update it with the new data
   • If it doesn't exist, create a new instance

You can customize the processing logic based on your specific requirements, such as how to handle conflicts or which fields to update.

Additional Considerations

1. Error Handling: Add proper error handling for invalid JSON, missing fields, etc.
2. Validation: Validate the JSON data before processing to ensure it meets your requirements
3. Permissions: Ensure only authorized users can access the import functionality
4. Transactions: Consider using database transactions to ensure data integrity

This approach gives you a clean, admin-integrated way to import your JSON data while maintaining full control over how the data is processed and updated.

Integrating JSON Import into Django Admin

You can integrate your JSON import functionality into the Django Admin interface by creating a custom admin action or a custom admin view. Here are two approaches:

Option 1: Custom Admin Action with File Upload

This approach adds a custom action to your model's admin page that allows you to upload and process a JSON file:

PYTHONCopied
# yourapp/admin.py
from django.contrib import admin
from django.http import HttpResponseRedirect
from django.template.response import TemplateResponse
from django.urls import path
from django import forms
import json

from .models import YourModel

class JsonUploadForm(forms.Form):
    json_file = forms.FileField()

class YourModelAdmin(admin.ModelAdmin):
    actions = ['import_from_json']
    
    def import_from_json(self, request, queryset):
        if 'apply' in request.POST:
            # Process the uploaded file
            json_file = request.FILES['json_file']
            data = json.loads(json_file.read().decode('utf-8'))
            
            # Process your data here
            for item in data:
                # Example: Check if item exists by title
                title = item.get('title')
                if title:
                    obj, created = YourModel.objects.get_or_create(title=title)
                    # Update fields
                    for key, value in item.items():
                        if hasattr(obj, key):
                            setattr(obj, key, value)
                    obj.save()
            
            self.message_user(request, "JSON data imported successfully.")
            return HttpResponseRedirect(request.get_full_path())
        
        form = JsonUploadForm()
        context = {
            'title': "Import JSON Data",
            'form': form,
            'queryset': queryset,
            'action_checkbox_name': admin.helpers.ACTION_CHECKBOX_NAME,
        }
        return TemplateResponse(request, 'admin/import_json.html', context)
    
    import_from_json.short_description = "Import data from JSON file"

admin.site.register(YourModel, YourModelAdmin)

You'll need to create a template for the upload form:

HTMLCopied
<!-- templates/admin/import_json.html -->
{% extends "admin/base_site.html" %}

{% block content %}
<h1>{{ title }}</h1>
<form action="" method="post" enctype="multipart/form-data">
    {% csrf_token %}
    {{ form.as_p }}
    <input type="hidden" name="action" value="import_from_json" />
    <input type="submit" name="apply" value="Upload and Import" />
</form>
{% endblock %}

Option 2: Custom Admin View with Button

This approach adds a custom view and button to your admin interface:

PYTHONCopied
# yourapp/admin.py
from django.contrib import admin
from django.http import HttpResponseRedirect
from django.template.response import TemplateResponse
from django.urls import path
from django import forms
import json

from .models import YourModel

class JsonUploadForm(forms.Form):
    json_file = forms.FileField()

class YourModelAdmin(admin.ModelAdmin):
    change_list_template = 'admin/yourapp/yourmodel/change_list.html'
    
    def get_urls(self):
        urls = super().get_urls()
        custom_urls = [
            path('import-json/', self.import_json_view, name='import_json'),
        ]
        return custom_urls + urls
    
    def import_json_view(self, request):
        if request.method == 'POST':
            form = JsonUploadForm(request.POST, request.FILES)
            if form.is_valid():
                json_file = request.FILES['json_file']
                data = json.loads(json_file.read().decode('utf-8'))
                
                # Process your data here
                for item in data:
                    # Example: Check if item exists by title
                    title = item.get('title')
                    if title:
                        obj, created = YourModel.objects.get_or_create(title=title)
                        # Update fields
                        for key, value in item.items():
                            if hasattr(obj, key):
                                setattr(obj, key, value)
                        obj.save()
                
                self.message_user(request, "JSON data imported successfully.")
                return HttpResponseRedirect("../")
        else:
            form = JsonUploadForm()
        
        context = {
            'title': "Import JSON Data",
            'form': form,
            'opts': self.model._meta,
        }
        return TemplateResponse(request, 'admin/import_json_form.html', context)

admin.site.register(YourModel, YourModelAdmin)

Create the necessary templates:

HTMLCopied
<!-- templates/admin/yourapp/yourmodel/change_list.html -->
{% extends "admin/change_list.html" %}
{% load i18n %}

{% block object-tools-items %}
    <li>
        <a href="import-json/" class="addlink">{% trans "Import JSON" %}</a>
    </li>
    {{ block.super }}
{% endblock %}

HTMLCopied
<!-- templates/admin/import_json_form.html -->
{% extends "admin/base_site.html" %}
{% load i18n admin_urls %}

{% block breadcrumbs %}
<div class="breadcrumbs">
    <a href="{% url 'admin:index' %}">{% trans 'Home' %}</a>
    &rsaquo; <a href="{% url 'admin:app_list' app_label=opts.app_label %}">{{ opts.app_config.verbose_name }}</a>
    &rsaquo; <a href="{% url opts|admin_urlname:'changelist' %}">{{ opts.verbose_name_plural|capfirst }}</a>
    &rsaquo; {% trans 'Import JSON' %}
</div>
{% endblock %}

{% block content %}
<h1>{% trans 'Import JSON' %}</h1>
<div id="content-main">
    <form method="post" enctype="multipart/form-data">
        {% csrf_token %}
        {{ form.as_p }}
        <div class="submit-row">
            <input type="submit" class="default" value="{% trans 'Upload' %}">
        </div>
    </form>
</div>
{% endblock %}

Handling the Data Import Logic

In both approaches, you'll need to customize the data processing logic to match your specific models and requirements. Here's a more detailed example of how you might handle the import logic:

PYTHONCopied
def process_json_data(data, model_class):
    results = {
        'created': 0,
        'updated': 0,
        'errors': 0
    }
    
    for item in data:
        try:
            # Determine the unique identifier field (e.g., 'title')
            identifier_field = 'title'
            identifier_value = item.get(identifier_field)
            
            if not identifier_value:
                results['errors'] += 1
                continue
                
            # Try to find an existing object
            try:
                obj = model_class.objects.get(**{identifier_field: identifier_value})
                is_new = False
            except model_class.DoesNotExist:
                obj = model_class(**{identifier_field: identifier_value})
                is_new = True
            
            # Update fields
            for key, value in item.items():
                if hasattr(obj, key):
                    setattr(obj, key, value)
            
            obj.save()
            
            if is_new:
                results['created'] += 1
            else:
                results['updated'] += 1
                
        except Exception as e:
            results['errors'] += 1
            # You might want to log the error
            
    return results

This approach gives you a user-friendly way to import JSON data directly from the Django Admin interface, with proper error handling and feedback to the user.