django-duplicator 0.1.0__py3-none-any.whl

django_duplicator-0.1.0.dist-info/METADATA

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: django-duplicator
+Version: 0.1.0
+Summary: A reusable Django app to easily duplicate model records.
+License: MIT
+License-File: LICENSE
+Keywords: django,admin,mixin,djang-duplicator,bulk-action
+Author: Ferdina Kusumah
+Author-email: ferdina.kusumah@gmail.com
+Requires-Python: >=3.8,<4.0
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: Django (>=3.2)
+Project-URL: Homepage, https://github.com/FerdinaKusumah/duplicator
+Project-URL: Repository, https://github.com/FerdinaKusumah/duplicator
+Description-Content-Type: text/markdown
+
+# Django Duplicator 🔁
+
+A lightweight mixin for Django Admin that adds object duplication functionality, both in bulk (via an Admin Action) and
+for single objects (via a "Duplicate and continue editing" button on the change form).
+
+---
+
+## ✨ Key Features
+
+* **Single Object Duplication**: A "Duplicate and continue editing" button appears on the object detail page.
+* **Bulk Duplication (Admin Action)**: An Admin Action is provided to duplicate selected objects from the changelist
+  page.
+* **DRY and Flexible**: Uses simple model and Admin mixins that are easy to integrate into any Django model.
+
+---
+
+## 💻 Installation
+
+```shell
+  pip install django-duplicator
+```
+
+Add `duplicator` to your `INSTALLED_APPS` in settings.py:
+
+```shell
+# settings.py
+INSTALLED_APPS = [
+    # ...
+    'django.contrib.admin',
+    # ...
+    'duplicator',
+]
+```
+
+## 🚀 Usage
+
+1. Model (Enabling Duplication)
+
+To make your model duplicatable, you must inherit from DuplicatorMixin.
+
+```shell
+    # models.py
+    from django.db import models
+    from duplicator import DuplicatorMixin
+    
+    class Customer(DuplicatorMixin, models.Model):
+        name = models.CharField(max_length=255)
+        # ... other fields ...
+    
+        def __str__(self):
+            return self.name
+```
+
+2. Admin (Enabling Buttons and Actions)
+
+To enable both the single duplication button and the bulk duplication Admin Action, inherit from
+DuplicatorAdminMixin.
+
+```shell
+# admin.py
+from django.contrib import admin
+from duplicator import DuplicatorAdminMixin
+from .models import Customer
+
+@admin.register(Customer)
+class CustomerAdmin(DuplicatorAdminMixin, admin.ModelAdmin):
+    list_display = ('name', 'id')
+    # ... other admin configurations ...
+```
+
+## 📸 Feature Demonstration
+
+### A. Bulk Duplication (Admin Action)
+
+The duplication option appears in the Actions dropdown menu on the changelist page.
+
+![Action](./images/action.png)
+
+### B. Single Duplication (Change Form Button)
+
+The "Duplicate and continue editing" button is prominently placed on the object detail page.
+
+![Detail](./images/detail.png)
+
+## 🤝 Contributing
+
+We welcome all contributions! If you find a bug or have a feature suggestion, please open an Issue or submit a Pull
+Request.
+
+## 📄 License
+
+This project is licensed under the [Your License Type, e.g., MIT License]. See the LICENSE file for full details.

django_duplicator-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+duplicator/__init__.py,sha256=4xB06_5sDQEKIzOEZXJDU_IMpE-LQ9WM7o6nu3taBnE,76
+duplicator/admin.py,sha256=pQEc0_1jTnrAKQ1WX5TGEGYkDMKB8nkKSnKs-XINk5c,2672
+duplicator/apps.py,sha256=tPN8zWRtfJNYIov9IoKAcRrCo-FeI1T1kjj059EpQbM,199
+duplicator/models.py,sha256=78xq6STQsjLzDLI1PJJMBQDM8Oy_k-hvlznzyGQHdX8,581
+duplicator/templates/admin/duplicator/change_form.html,sha256=gj6SC5NfbNk99egnAyyQ7E9ZPigWHnsMyfRlYI6nV9U,1274
+django_duplicator-0.1.0.dist-info/METADATA,sha256=RAzA_BboDbZXX7t8hE_diVRPCCY0gIbJjbPX_73RA6w,3657
+django_duplicator-0.1.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+django_duplicator-0.1.0.dist-info/licenses/LICENSE,sha256=0KpTO1gQ1QO9D-1yoKjK8yc_YBFR6Dcb45IP2mLhzlk,1072
+django_duplicator-0.1.0.dist-info/RECORD,,

django_duplicator-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.2.1
+Root-Is-Purelib: true
+Tag: py3-none-any

django_duplicator-0.1.0.dist-info/licenses/LICENSE

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

duplicator/__init__.py

@@ -0,0 +1,2 @@
+from .admin import DuplicatorAdminMixin
+from .models import DuplicatorMixin

duplicator/admin.py

@@ -0,0 +1,89 @@
+from copy import copy
+
+from django.contrib import admin
+from django.contrib import messages
+from django.shortcuts import redirect
+from django.urls import path
+from django.utils.translation import gettext_lazy as _
+
+
+@admin.action(description=_("Duplicate selected %(verbose_name_plural)s"))
+def duplicate_selected_objects(model_admin, request, queryset):
+    if not model_admin.has_add_permission(request):
+        model_admin.message_user(
+            request,
+            _("You do not have permission to duplicate these objects."),
+            level=messages.ERROR,
+        )
+        return
+
+    cnt = 0
+    for obj in queryset:
+        model_admin._duplicate(obj)
+        cnt += 1
+
+    model_admin.message_user(
+        request, _("Successfully duplicated %d records" % cnt), level=messages.SUCCESS
+    )
+
+
+class DuplicatorAdminMixin(admin.ModelAdmin):
+    change_form_template = "admin/duplicator/change_form.html"
+    actions = [duplicate_selected_objects]
+
+    def _duplicate(self, original_object):
+        if hasattr(original_object, "clone"):
+            new_object = original_object.clone()
+        else:
+            new_object = copy(original_object)
+            new_object.pk = None
+            if hasattr(new_object, "name"):
+                new_object.name = "{} (Copy)".format(new_object.name)
+
+            new_object.save()
+
+        return new_object
+
+    def get_urls(self):
+        urls = super(DuplicatorAdminMixin, self).get_urls()
+        info = self.model._meta.app_label, self.model._meta.model_name
+
+        custom_urls = [
+            path(
+                "<path:object_id>/duplicate/",
+                self.admin_site.admin_view(self.duplicate_view),
+                name="%s_%s_duplicate" % info,
+            ),
+        ]
+
+        return custom_urls + urls
+
+    def duplicate_view(self, request, object_id):
+        if not self.has_add_permission(request):
+            return self.message_user(
+                request,
+                _("You do not have permission to duplicate this object."),
+                level=messages.ERROR,
+            )
+
+        original_object = self.get_object(request, object_id)
+
+        # not found
+        if not original_object:
+            return redirect("..")
+
+        # clone object
+        new_object = self._duplicate(original_object)
+
+        self.message_user(
+            request,
+            _('Successfully duplicated object "%(obj)s".')
+            % {"obj": str(original_object)},
+            level=messages.SUCCESS,
+        )
+
+        return redirect(
+            "admin:%s_%s_change"
+            % (new_object._meta.app_label, new_object._meta.model_name),
+            new_object.pk,
+        )

duplicator/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class DuplicatorConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "duplicator"
+    verbose_name = "Django duplicator utility"

duplicator/models.py

@@ -0,0 +1,25 @@
+from copy import copy
+
+
+class DuplicatorMixin:
+
+    def clone(self, commit=True, **kwargs):
+        # clone instance
+        new_instance = copy(self)
+
+        # remove id
+        new_instance.pk = None
+
+        # flag if record have name
+        if hasattr(new_instance, "name"):
+            new_instance.name = "{} (Copy)".format(new_instance.name)
+
+        # add kwargs if any
+        for key, value in kwargs.items():
+            setattr(new_instance, key, value)
+
+        if commit:
+            # save new instance
+            new_instance.save()
+
+        return new_instance

duplicator/templates/admin/duplicator/change_form.html

@@ -0,0 +1,42 @@
+{% extends "admin/change_form.html" %}
+{% load i18n admin_urls admin_modify static %}
+
+{% block submit_buttons_bottom %}
+{{ block.super }}
+
+{% if change and original.pk %}
+{% url opts|admin_urlname:'duplicate' original.pk|admin_urlquote as duplicate_url %}
+
+<div id="dup-btn-wrap" style="display: none;">
+    <a href="{% add_preserved_filters duplicate_url %}"
+       id="dup-btn-link"
+       class="button"
+       style="background: #417690;
+                      color: white;
+                      margin-left: 5px;
+                      float: left;
+                      border-radius: 4px;
+                      display: inline-block;
+                      text-decoration: none;
+                      padding: 10px 15px;">
+        {% translate 'Duplicate and continue editing' %}
+    </a>
+</div>
+{% endif %}
+
+{% block admin_change_form_document_ready %}
+{{ block.super }}
+
+{% if change and original.pk %}
+<script>document.addEventListener("DOMContentLoaded", (function () {
+    const e = document.getElementById("dup-btn-link"), n = document.querySelector('input[name="_continue"]');
+    if (n && e) {
+        n.after(e);
+        const t = document.getElementById("dup-btn-wrap");
+        t && t.remove()
+    }
+}));</script>
+{% endif %}
+{% endblock %}
+
+{% endblock %}