django-tabbed-admin3 3.1.0__tar.gz → 3.2.0__tar.gz

{django_tabbed_admin3-3.1.0 → django_tabbed_admin3-3.2.0}/MANIFEST.in

@@ -3,3 +3,4 @@ include LICENSE.txt
 include README.rst
 recursive-include tabbed_admin/static *
 recursive-include tabbed_admin/templates *
+prune tabbed_admin_exemple

django_tabbed_admin3-3.2.0/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: django-tabbed-admin3
+Version: 3.2.0
+Summary: Easily add tabs to django admin forms. Django 6.1 compatible fork.
+Author: Guillaume Pousseo (original), Michael Galler (django 4 fork)
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/mgaller/django-tabbed-admin3
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Django :: 6.0
+Classifier: Framework :: Django :: 6.1
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+License-File: AUTHORS.txt
+Requires-Dist: django>=4.2
+Dynamic: license-file
+
+###################
+Django tabbed admin
+###################
+
+This is a simple fork of django-tabbed-admin https://github.com/omji/django-tabbed-admin with compatibility updates for modern Django versions.
+
+Version 3.2 adds Django 6.1 support while retaining jQuery UI and the existing
+``TABBED_ADMIN_*`` settings. Tests cover Django 4.2, 5.0, 5.1, 5.2, 6.0 and 6.1.
+The change-form template now inherits Django's form controls, actions and popup
+fields instead of copying them. Projects overriding
+``tabbed_admin/change_form.html`` must update their override to use this fix.
+For integration with another admin extension, ``TabbedModelAdmin.tabbed_admin_base_template``
+can specify a parent template instead of ``admin/change_form.html``.
+The ``tabbed_admin_base_template`` context variable takes precedence over this
+attribute, allowing other admin extensions to supply the parent template.
+
+
+Simple library to easilly add tabs to admin forms. It also allows users to re-order inlines and fieldsets.
+Django tabbed admin is compatible with django-grappelli and django-gipsy.
+
+
+*******
+Install
+*******
+
+It is strongly recommanded to install this theme from GIT with PIP onto you project virtualenv.
+
+From PyPi
+
+.. code-block::  shell-session
+
+    pip install django-tabbed-admin3
+
+From Github
+
+.. code-block::  shell-session
+
+    https://github.com/mgaller/django-tabbed-admin3#egg=tabbed_admin
+
+
+*****
+setup
+*****
+
+Simply add the app in your installed apps list in settings.py
+
+.. code-block::  python
+
+    INSTALLED_APPS = (
+        ...
+        'tabbed_admin'
+        ...
+    )
+
+Django-tabbed-admin by default requires Jquery UI tabs plugin in order to work. It is packaged with the static files required to make it funcitonnal, however, they are not activated by default to avoid a conflict with other libraries.
+
+In order to activate the Jquery UI statics, add the following line to the project settings:
+
+.. code-block::  python
+
+    TABBED_ADMIN_USE_JQUERY_UI = True
+
+
+********************
+Configure admin tabs
+********************
+
+In order to add tabs to a model admin, it should inherit from tabbed_admin.TabbedModelAdmin and contain a tabs attribute.
+The tab attribute configuration tries to remain similar to the fieldsets and inlines setup logic.
+
+Basically, a tuple can be created for each tab exactely the same way as for fieldsets, except that inlines can be added anywhere in between.
+
+.. code-block::  python
+
+    tab_overview = (
+        (None, {
+            'fields': ('name', 'bio', 'style')
+        }),
+        MusicianInline,
+        ('Contact', {
+            'fields': ('agent', 'phone', 'email')
+        })
+    )
+
+Then each tuple have to be passed to a *tabs* attribute prefixed by the verbose name to display within the tab:
+
+.. code-block::  python
+
+    tabs = [
+        ('Overview', tab_overview),
+        ('Albums', tab_album)
+    ]
+
+
+A full example would give:
+
+.. code-block::  python
+
+    from django.contrib import admin
+
+    from tabbed_admin import TabbedModelAdmin
+    from .models import Band, Musician, Album
+
+
+    class MusicianInline(admin.StackedInline):
+        model = Musician
+        extra = 1
+
+
+    class AlbumInline(admin.TabularInline):
+        model = Album
+        extra = 1
+
+
+    @admin.register(Band)
+    class BandAdmin(TabbedModelAdmin):
+        model = Band
+
+        tab_overview = (
+            (None, {
+                'fields': ('name', 'bio', 'style')
+            }),
+            MusicianInline,
+            ('Contact', {
+                'fields': ('agent', 'phone', 'email')
+            })
+        )
+        tab_album = (
+            AlbumInline,
+        )
+        tabs = [
+            ('Overview', tab_overview),
+            ('Albums', tab_album)
+        ]
+
+**************************
+Configure tabs dynamically
+**************************
+
+Be warned that the tabs will completely reset the fieldsets and inlines attributes in order to avoid conflicts during the form saving. Both attributes are overwritten with the entries passed to the tabs attribute. For the same reasons, it is highly recommanded not to overwrite get_fieldsets or get_inlines.
+
+You can pass and modify the tabs dynamically the same way you would do for fieldsets or inlines.
+
+.. code-block::  python
+
+    def get_tabs(self, request, obj=None):
+        tabs = self.tabs
+        if obj is not None:
+            tab_overview = self.tab_overview + ('Social', {
+                'fields': ('website', 'twitter', 'facebook')
+            })
+            tab_ressources = self.tab_ressources + (InterviewInline, )
+            tabs = [
+                ('Overview', tab_overview),
+                ('Ressources', tab_ressources)
+            ]
+        self.tabs = tabs
+        return super(BandAdmin, self).get_tabs(request, obj)
+
+
+********************
+Change the jquery ui
+********************
+
+You can change the jquery ui css and js by either overriding the media in the
+admin class
+
+.. code-block:: python
+
+    class Media:
+        css = {
+            'all': ('css/jquery-ui.theme.min.css',)
+        }
+
+or by changing the the following settings,
+
+`TABBED_ADMIN_JQUERY_UI_CSS` and `TABBED_ADMIN_JQUERY_UI_JS`
+
+.. code-block:: python
+
+    TABBED_ADMIN_JQUERY_UI_CSS = 'static/css/my-custom-jquery-ui.css'
+    TABBED_ADMIN_JQUERY_UI_JS = 'static/js/my-custom-jquery-ui.js'
+
+
+Contribution
+************
+
+Please feel free to contribute. Any help and advices are much appreciated.
+You will find an example application to run and develop the library easily.
+
+Run the standalone test suite with ``PYTHONPATH=. python tabbed_admin/tests/runtests.py``.
+
+
+*****
+LINKS
+*****
+
+Development:
+    https://github.com/mgaller/django-tabbed-admin3
+
+Package:
+    https://pypi.python.org/pypi/django-tabbed-admin3

{django_tabbed_admin3-3.1.0 → django_tabbed_admin3-3.2.0}/README.rst

@@ -4,6 +4,16 @@ Django tabbed admin
 
 This is a simple fork of django-tabbed-admin https://github.com/omji/django-tabbed-admin with compatibility updates for modern Django versions.
 
+Version 3.2 adds Django 6.1 support while retaining jQuery UI and the existing
+``TABBED_ADMIN_*`` settings. Tests cover Django 4.2, 5.0, 5.1, 5.2, 6.0 and 6.1.
+The change-form template now inherits Django's form controls, actions and popup
+fields instead of copying them. Projects overriding
+``tabbed_admin/change_form.html`` must update their override to use this fix.
+For integration with another admin extension, ``TabbedModelAdmin.tabbed_admin_base_template``
+can specify a parent template instead of ``admin/change_form.html``.
+The ``tabbed_admin_base_template`` context variable takes precedence over this
+attribute, allowing other admin extensions to supply the parent template.
+
 
 Simple library to easilly add tabs to admin forms. It also allows users to re-order inlines and fieldsets.
 Django tabbed admin is compatible with django-grappelli and django-gipsy.
@@ -178,6 +188,8 @@ Contribution
 Please feel free to contribute. Any help and advices are much appreciated.
 You will find an example application to run and develop the library easily.
 
+Run the standalone test suite with ``PYTHONPATH=. python tabbed_admin/tests/runtests.py``.
+
 
 *****
 LINKS

django_tabbed_admin3-3.2.0/django_tabbed_admin3.egg-info/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: django-tabbed-admin3
+Version: 3.2.0
+Summary: Easily add tabs to django admin forms. Django 6.1 compatible fork.
+Author: Guillaume Pousseo (original), Michael Galler (django 4 fork)
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/mgaller/django-tabbed-admin3
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Django :: 6.0
+Classifier: Framework :: Django :: 6.1
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+License-File: AUTHORS.txt
+Requires-Dist: django>=4.2
+Dynamic: license-file
+
+###################
+Django tabbed admin
+###################
+
+This is a simple fork of django-tabbed-admin https://github.com/omji/django-tabbed-admin with compatibility updates for modern Django versions.
+
+Version 3.2 adds Django 6.1 support while retaining jQuery UI and the existing
+``TABBED_ADMIN_*`` settings. Tests cover Django 4.2, 5.0, 5.1, 5.2, 6.0 and 6.1.
+The change-form template now inherits Django's form controls, actions and popup
+fields instead of copying them. Projects overriding
+``tabbed_admin/change_form.html`` must update their override to use this fix.
+For integration with another admin extension, ``TabbedModelAdmin.tabbed_admin_base_template``
+can specify a parent template instead of ``admin/change_form.html``.
+The ``tabbed_admin_base_template`` context variable takes precedence over this
+attribute, allowing other admin extensions to supply the parent template.
+
+
+Simple library to easilly add tabs to admin forms. It also allows users to re-order inlines and fieldsets.
+Django tabbed admin is compatible with django-grappelli and django-gipsy.
+
+
+*******
+Install
+*******
+
+It is strongly recommanded to install this theme from GIT with PIP onto you project virtualenv.
+
+From PyPi
+
+.. code-block::  shell-session
+
+    pip install django-tabbed-admin3
+
+From Github
+
+.. code-block::  shell-session
+
+    https://github.com/mgaller/django-tabbed-admin3#egg=tabbed_admin
+
+
+*****
+setup
+*****
+
+Simply add the app in your installed apps list in settings.py
+
+.. code-block::  python
+
+    INSTALLED_APPS = (
+        ...
+        'tabbed_admin'
+        ...
+    )
+
+Django-tabbed-admin by default requires Jquery UI tabs plugin in order to work. It is packaged with the static files required to make it funcitonnal, however, they are not activated by default to avoid a conflict with other libraries.
+
+In order to activate the Jquery UI statics, add the following line to the project settings:
+
+.. code-block::  python
+
+    TABBED_ADMIN_USE_JQUERY_UI = True
+
+
+********************
+Configure admin tabs
+********************
+
+In order to add tabs to a model admin, it should inherit from tabbed_admin.TabbedModelAdmin and contain a tabs attribute.
+The tab attribute configuration tries to remain similar to the fieldsets and inlines setup logic.
+
+Basically, a tuple can be created for each tab exactely the same way as for fieldsets, except that inlines can be added anywhere in between.
+
+.. code-block::  python
+
+    tab_overview = (
+        (None, {
+            'fields': ('name', 'bio', 'style')
+        }),
+        MusicianInline,
+        ('Contact', {
+            'fields': ('agent', 'phone', 'email')
+        })
+    )
+
+Then each tuple have to be passed to a *tabs* attribute prefixed by the verbose name to display within the tab:
+
+.. code-block::  python
+
+    tabs = [
+        ('Overview', tab_overview),
+        ('Albums', tab_album)
+    ]
+
+
+A full example would give:
+
+.. code-block::  python
+
+    from django.contrib import admin
+
+    from tabbed_admin import TabbedModelAdmin
+    from .models import Band, Musician, Album
+
+
+    class MusicianInline(admin.StackedInline):
+        model = Musician
+        extra = 1
+
+
+    class AlbumInline(admin.TabularInline):
+        model = Album
+        extra = 1
+
+
+    @admin.register(Band)
+    class BandAdmin(TabbedModelAdmin):
+        model = Band
+
+        tab_overview = (
+            (None, {
+                'fields': ('name', 'bio', 'style')
+            }),
+            MusicianInline,
+            ('Contact', {
+                'fields': ('agent', 'phone', 'email')
+            })
+        )
+        tab_album = (
+            AlbumInline,
+        )
+        tabs = [
+            ('Overview', tab_overview),
+            ('Albums', tab_album)
+        ]
+
+**************************
+Configure tabs dynamically
+**************************
+
+Be warned that the tabs will completely reset the fieldsets and inlines attributes in order to avoid conflicts during the form saving. Both attributes are overwritten with the entries passed to the tabs attribute. For the same reasons, it is highly recommanded not to overwrite get_fieldsets or get_inlines.
+
+You can pass and modify the tabs dynamically the same way you would do for fieldsets or inlines.
+
+.. code-block::  python
+
+    def get_tabs(self, request, obj=None):
+        tabs = self.tabs
+        if obj is not None:
+            tab_overview = self.tab_overview + ('Social', {
+                'fields': ('website', 'twitter', 'facebook')
+            })
+            tab_ressources = self.tab_ressources + (InterviewInline, )
+            tabs = [
+                ('Overview', tab_overview),
+                ('Ressources', tab_ressources)
+            ]
+        self.tabs = tabs
+        return super(BandAdmin, self).get_tabs(request, obj)
+
+
+********************
+Change the jquery ui
+********************
+
+You can change the jquery ui css and js by either overriding the media in the
+admin class
+
+.. code-block:: python
+
+    class Media:
+        css = {
+            'all': ('css/jquery-ui.theme.min.css',)
+        }
+
+or by changing the the following settings,
+
+`TABBED_ADMIN_JQUERY_UI_CSS` and `TABBED_ADMIN_JQUERY_UI_JS`
+
+.. code-block:: python
+
+    TABBED_ADMIN_JQUERY_UI_CSS = 'static/css/my-custom-jquery-ui.css'
+    TABBED_ADMIN_JQUERY_UI_JS = 'static/js/my-custom-jquery-ui.js'
+
+
+Contribution
+************
+
+Please feel free to contribute. Any help and advices are much appreciated.
+You will find an example application to run and develop the library easily.
+
+Run the standalone test suite with ``PYTHONPATH=. python tabbed_admin/tests/runtests.py``.
+
+
+*****
+LINKS
+*****
+
+Development:
+    https://github.com/mgaller/django-tabbed-admin3
+
+Package:
+    https://pypi.python.org/pypi/django-tabbed-admin3

{django_tabbed_admin3-3.1.0 → django_tabbed_admin3-3.2.0}/django_tabbed_admin3.egg-info/SOURCES.txt

@@ -3,8 +3,6 @@ LICENSE.txt
 MANIFEST.in
 README.rst
 pyproject.toml
-setup.cfg
-setup.py
 django_tabbed_admin3.egg-info/PKG-INFO
 django_tabbed_admin3.egg-info/SOURCES.txt
 django_tabbed_admin3.egg-info/dependency_links.txt
@@ -46,12 +44,4 @@ tabbed_admin/tests/admin.py
 tabbed_admin/tests/models.py
 tabbed_admin/tests/runtests.py
 tabbed_admin/tests/tests.py
-tabbed_admin/tests/urls.py
-tabbed_admin_exemple/manage.py
-tabbed_admin_exemple/tabbed_admin_exemple/__init__.py
-tabbed_admin_exemple/tabbed_admin_exemple/settings.py
-tabbed_admin_exemple/tabbed_admin_exemple/urls.py
-tabbed_admin_exemple/tabbed_admin_exemple/wsgi.py
-tabbed_admin_exemple/tabbed_admin_exemple/band/__init__.py
-tabbed_admin_exemple/tabbed_admin_exemple/band/admin.py
-tabbed_admin_exemple/tabbed_admin_exemple/band/models.py
+tabbed_admin/tests/urls.py

django_tabbed_admin3-3.2.0/django_tabbed_admin3.egg-info/top_level.txt

@@ -0,0 +1 @@
+tabbed_admin

{django_tabbed_admin3-3.1.0 → django_tabbed_admin3-3.2.0}/pyproject.toml

@@ -1,13 +1,14 @@
 [build-system]
-requires = ["setuptools>=68.0", "wheel"]
+requires = ["setuptools>=77.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "django-tabbed-admin3"
-version = "3.1.0"
-description = "Easily add tabs to django admin forms. Django 6 compatible fork."
-readme = "README.md"
-license = {text = "BSD License"}
+version = "3.2.0"
+description = "Easily add tabs to django admin forms. Django 6.1 compatible fork."
+readme = "README.rst"
+license = "BSD-3-Clause"
+license-files = ["LICENSE.txt", "AUTHORS.txt"]
 authors = [
     {name = "Guillaume Pousseo (original)"},
     {name = "Michael Galler (django 4 fork)"},
@@ -23,8 +24,8 @@ classifiers = [
     "Framework :: Django :: 5.1",
     "Framework :: Django :: 5.2",
     "Framework :: Django :: 6.0",
+    "Framework :: Django :: 6.1",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: BSD License",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.10",
@@ -39,3 +40,18 @@ Homepage = "https://github.com/mgaller/django-tabbed-admin3"
 
 [tool.setuptools.packages.find]
 include = ["tabbed_admin*"]
+namespaces = false
+
+[tool.setuptools]
+include-package-data = false
+
+[tool.setuptools.package-data]
+tabbed_admin = ["templates/**/*.html", "static/**/*.css", "static/**/*.js", "static/**/*.png"]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+ignore = ["E501"]

django_tabbed_admin3-3.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

{django_tabbed_admin3-3.1.0 → django_tabbed_admin3-3.2.0}/tabbed_admin/admin.py

@@ -2,7 +2,7 @@ from django.conf import settings
 from django.contrib.admin.options import ModelAdmin
 from django.utils.translation import gettext_lazy as _
 
-from .settings import USE_JQUERY_UI, JQUERY_UI_CSS, JQUERY_UI_JS
+from .settings import JQUERY_UI_CSS, JQUERY_UI_JS, USE_JQUERY_UI
 
 
 class TabbedModelAdmin(ModelAdmin):
@@ -11,6 +11,7 @@ class TabbedModelAdmin(ModelAdmin):
 
     # Needs a specific template to display the tabs
     change_form_template = "tabbed_admin/change_form.html"
+    tabbed_admin_base_template = "admin/change_form.html"
 
     def get_fieldsets(self, request, obj=None):
         """
@@ -62,6 +63,8 @@ class TabbedModelAdmin(ModelAdmin):
         """
         if self.tabs:
             self.parse_fieldsets_inlines_from_tabs(request, obj)
+        else:
+            self.formatted_tabs = {"fields": [], "fieldsets": (), "inlines": ()}
         return self.formatted_tabs
 
     def parse_fieldsets_inlines_from_tabs(self, request, obj=None):
@@ -71,25 +74,16 @@ class TabbedModelAdmin(ModelAdmin):
         """
         tabs_fieldsets = ()
         tabs_inlines = ()
-        self.formatted_tabs["fields"] = []
+        self.formatted_tabs = {"fields": []}
         for tab in self.get_tabs(request, obj):
             # Checks that each tab is formatted with 2 arguments: verbose name
             # of the tab and the tab configuration.
             if not isinstance(tab, (tuple, list)):
-                raise TypeError(
-                    _("Each tab entry must be either a list or a tuple")
-                )
+                raise TypeError(_("Each tab entry must be either a list or a tuple"))
             if len(tab) != 2:
-                raise ValueError(
-                    _(
-                        "Each tabs entry must contain 2 arguments: "
-                        "a verbose name and the tab setup."
-                    )
-                )
+                raise ValueError(_("Each tabs entry must contain 2 arguments: a verbose name and the tab setup."))
             if not isinstance(tab[1], (tuple, list)):
-                raise TypeError(
-                    _("A tab definition must be either a list or a tuple")
-                )
+                raise TypeError(_("A tab definition must be either a list or a tuple"))
             # Parse the tab configuration: if an entry is a tuple or a list
             # it's a fieldset, otherwise it's an inline class.
             formatted_tab = {"name": tab[0], "entries": []}
@@ -100,6 +94,7 @@ class TabbedModelAdmin(ModelAdmin):
                         "type": "fieldset",
                         "name": tab_entry[0],
                         "config": tab_entry[1],
+                        "index": len(tabs_fieldsets) - 1,
                     }
                 else:
                     tabs_inlines = tabs_inlines + (tab_entry,)
@@ -112,29 +107,19 @@ class TabbedModelAdmin(ModelAdmin):
         self.formatted_tabs["fieldsets"] = tabs_fieldsets
         self.formatted_tabs["inlines"] = tabs_inlines
 
-    def add_view(self, request, form_url="", extra_context=None):
-        """
-        Overwrites add_view to insert the tabs config for the template.
-        """
-        if extra_context is None:
-            extra_context = {}
-        extra_context.update({"tabs": self.get_formatted_tabs(request)})
-        return super().add_view(
-            request, form_url=form_url, extra_context=extra_context
-        )
-
-    def change_view(self, request, object_id, form_url="", extra_context=None):
-        """
-        Overwrites change_view to insert the tabs config for the template.
-        """
-        if extra_context is None:
-            extra_context = {}
-        extra_context.update({"tabs": self.get_formatted_tabs(request)})
-        return super().change_view(
+    def render_change_form(self, request, context, add=False, change=False, form_url="", obj=None):
+        context = {
+            **context,
+            "tabs": self.get_formatted_tabs(request, obj),
+            "tabbed_admin_base_template": context.get("tabbed_admin_base_template", self.tabbed_admin_base_template),
+        }
+        return super().render_change_form(
             request,
-            object_id,
+            context,
+            add=add,
+            change=change,
             form_url=form_url,
-            extra_context=extra_context,
+            obj=obj,
         )
 
     class Media: