Import the TreeAdmin from feincms3

Author: matthiask

.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
       fail-fast: false
       max-parallel: 5
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.8", "3.10", "3.11", "3.12", "3.13"]
 
     services:
       mariadb:
@@ -69,7 +69,7 @@ jobs:
       fail-fast: false
       max-parallel: 5
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.8", "3.10", "3.11", "3.12", "3.13"]
 
     services:
       postgres:
@@ -125,7 +125,7 @@ jobs:
       fail-fast: false
       max-parallel: 5
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.8", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
       - uses: actions/checkout@v4

CHANGELOG.rst

@@ -7,6 +7,10 @@ Next version
 - Added the missing ``FieldDoesNotExist`` import. Thanks Kircheneer.
 - Fixed all errors reported by pre-commit and started running hooks
   automatically.
+- Added ``TreeAdmin`` class for Django admin with intuitive tree
+  management, node moving capabilities, and support for both positioned and
+  unpositioned trees. Requires ``django-js-asset`` which is included in the new
+  ``admin`` extra.
 
 
 0.20 (2025-06-11)

README.rst

@@ -468,3 +468,56 @@ Example with depth-limited queryset:
 
 This is particularly useful for creating expandable tree interfaces or
 rendering only portions of large trees for performance.
+
+
+Django Admin Integration
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+django-tree-queries includes a ``TreeAdmin`` class for Django's admin interface
+that provides an intuitive tree management experience with drag-and-drop style
+node moving capabilities.
+
+Installation
+------------
+
+To use the admin functionality, install with the ``admin`` extra:
+
+.. code-block:: bash
+
+    pip install django-tree-queries[admin]
+
+Usage
+-----
+
+.. code-block:: python
+
+    from django.contrib import admin
+    from tree_queries.admin import TreeAdmin
+    from .models import Category
+
+    @admin.register(Category)
+    class CategoryAdmin(TreeAdmin):
+        list_display = [*TreeAdmin.list_display, "name", "is_active"]
+        position_field = "position"  # Optional: field used for sibling ordering
+
+The ``TreeAdmin`` provides:
+
+- **Tree visualization**: Nodes are displayed with indentation and visual tree structure
+- **Collapsible nodes**: Click to expand/collapse branches for better navigation
+- **Node moving**: Cut and paste nodes to reorganize the tree structure
+- **Flexible ordering**: Supports both ordered (with position field) and unordered trees
+- **Root moves**: Direct "move to root" buttons for trees without sibling ordering
+
+**Configuration:**
+
+- Set ``position_field`` to the field name used for positioning siblings (e.g., ``"position"``, ``"order"``)
+- Leave ``position_field = None`` for trees positioned by other criteria (pk, name, etc.)
+- The admin automatically adapts its interface based on whether positioning is controllable
+
+**Required list_display columns:**
+
+- ``collapse_column``: Shows expand/collapse toggles
+- ``indented_title``: Displays the tree structure with indentation
+- ``move_column``: Provides move controls (cut, paste, move-to-root)
+
+These are included by default in ``TreeAdmin.list_display``.

pyproject.toml

@@ -33,8 +33,14 @@ classifiers = [
 dynamic = [
   "version",
 ]
+dependencies = [
+]
+optional-dependencies.admin = [
+  "django-js-asset",
+]
 optional-dependencies.tests = [
   "coverage",
+  "django-js-asset",
   "pytest",
   "pytest-cov",
   "pytest-django",

tests/testapp/admin.py

@@ -1,8 +1,20 @@
 from django.contrib import admin
 
 from testapp import models
+from tree_queries.admin import TreeAdmin
 
 
 @admin.register(models.Model)
-class ModelAdmin(admin.ModelAdmin):
-    list_display = ("name",)
+class ModelAdmin(TreeAdmin):
+    position_field = "order"
+    list_display = [*TreeAdmin.list_display, "name"]
+
+
+@admin.register(models.UnorderedModel)
+class UnorderedModelAdmin(TreeAdmin):
+    list_display = [*TreeAdmin.list_display, "name"]
+
+
+@admin.register(models.StringOrderedModel)
+class StringOrderedModelAdmin(TreeAdmin):
+    list_display = [*TreeAdmin.list_display, "name"]

tests/testapp/settings.py

@@ -22,12 +22,12 @@
     }
 
 INSTALLED_APPS = [
-    # "django.contrib.auth",
-    # "django.contrib.admin",
-    # "django.contrib.contenttypes",
-    # "django.contrib.sessions",
-    # "django.contrib.staticfiles",
-    # "django.contrib.messages",
+    "django.contrib.auth",
+    "django.contrib.admin",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.staticfiles",
+    "django.contrib.messages",
     "testapp",
     "tree_queries",
 ]