django-admin-modern-view 0.2.1__tar.gz

django_admin_modern_view-0.2.1/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## 0.1.0 — Initial release
+
+- Modern application shell for `django.contrib.admin`: sticky topbar, collapsible/searchable sidebar with per-app collapse, light/dark theme (built on Django's own theme toggle).
+- Command palette (`Ctrl+K`): fuzzy navigation + create commands, auto-derived from the admin site, plus a `register_command()` API for custom entries.
+- Global search: searches every `ModelAdmin` with `search_fields` (auto-registered) or explicitly via `register_global_search()`; permission-aware.
+- Keyboard shortcuts: `Ctrl+K` search, `Ctrl+S` / `Ctrl+Shift+S` save, `J`/`K`/`Enter`/`Space` row navigation on change lists, `?` shortcut help, `Esc` closes the active overlay.
+- Enhanced change list: sticky header, keyboard row navigation, a Frappe-style "Filters" dropdown built from your existing `list_filter` configuration.
+- Enhanced change form: sticky save bar with a dirty-state indicator and an unsaved-changes warning on navigation.
+- Dashboard: per-model stat cards and collapsible per-app sections with model counts, replacing the plain app-list index.
+- `django_admin_modern_view.W001` system check: warns if the app is misordered relative to `django.contrib.admin` in `INSTALLED_APPS`.
+- Zero changes required to existing `ModelAdmin` classes — everything layers on top of `list_display`, `list_filter`, `search_fields`, `fieldsets`, `inlines`, `actions`, and permissions as already configured.

django_admin_modern_view-0.2.1/LICENSE

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

django_admin_modern_view-0.2.1/MANIFEST.in

@@ -0,0 +1,5 @@
+recursive-include src/django_adminkit/templates *.html
+recursive-include src/django_adminkit/static *.css *.js
+include README.md
+include LICENSE
+include CHANGELOG.md

django_admin_modern_view-0.2.1/PKG-INFO

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: django-admin-modern-view
+Version: 0.2.1
+Summary: A modern, keyboard-first UI layer for Django's built-in admin — command palette, global search, dashboard, and more, on top of your existing ModelAdmin config.
+Author: Hitesh
+License: MIT
+Project-URL: Homepage, https://github.com/HItzz07/Django-adminkit
+Project-URL: Repository, https://github.com/HItzz07/Django-adminkit
+Project-URL: Issues, https://github.com/HItzz07/Django-adminkit/issues
+Keywords: django,admin,ui,command-palette,dashboard
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django<6.0,>=5.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4; extra == "dev"
+Requires-Dist: pytest-django>=4.7; extra == "dev"
+Dynamic: license-file
+
+# django-admin-modern-view
+
+A modern, keyboard-first UI layer for Django's built-in admin. Drop it into
+`INSTALLED_APPS`, keep your existing `ModelAdmin` classes exactly as they
+are, and the admin gets a command palette, global search, a real dashboard,
+and a reskinned shell — without giving up anything Django's admin already
+does for you (permissions, `list_filter`, inlines, actions, forms).
+
+This is **not** a fork of `django.contrib.admin` and it does not replace it.
+It ships two small template overrides (the shell + the dashboard) and pure
+CSS/JS progressive enhancement on top of the admin's existing, stable DOM
+(`#result_list`, `#changelist-filter`, `.submit-row`, `#nav-sidebar`, …).
+Every page Django's admin can render, it can still render with this
+installed — worst case you lose the extra chrome, you never lose function.
+
+## Features
+
+- **Command palette** (`Ctrl+K`) — fuzzy-search navigation and "create"
+  commands, generated from your admin site's registered models, plus a
+  `register_command()` API for anything custom.
+- **Global search** — searches every `ModelAdmin` that already defines
+  `search_fields` (zero config), permission-checked per model.
+- **Keyboard shortcuts** — `Ctrl+S`/`Ctrl+Shift+S` save, `J`/`K`/`Enter`/
+  `Space` to navigate and select change-list rows, `?` for a shortcut
+  cheat sheet, `Esc` closes whatever overlay is open.
+- **Enhanced change list** — sticky header, keyboard row navigation, and a
+  dropdown "Filters" panel built from your existing `list_filter`.
+- **Enhanced change form** — sticky save bar, dirty-state indicator,
+  unsaved-changes warning before navigating away.
+- **Dashboard** — per-model stat cards and collapsible per-app sections
+  (with model counts) in place of the plain default app list.
+- **Light/dark theme** — reskins Django's own built-in theme toggle; no
+  separate dark-mode system to maintain.
+- A system check that catches the #1 setup mistake (see below) instead of
+  failing silently.
+
+## Requirements
+
+- Django 5.1 or newer (uses the admin's built-in dark-mode theme toggle and
+  collapsible sidebar, both introduced in 5.1).
+- Python 3.10+.
+
+## Install
+
+```bash
+pip install django-admin-modern-view
+```
+
+Or, until it's published, install straight from GitHub:
+
+```bash
+pip install git+https://github.com/HItzz07/Django-adminkit.git
+```
+
+For local development against this repo:
+
+```bash
+pip install -e /path/to/django-admin-modern-view
+```
+
+## Quickstart
+
+1. Add it to `INSTALLED_APPS`, **before** `django.contrib.admin` — Django's
+   template loader resolves `admin/*.html` overrides by walking
+   `INSTALLED_APPS` in order and using the first match:
+
+   ```python
+   INSTALLED_APPS = [
+       "django_admin_modern_view",   # must come before django.contrib.admin
+
+       "django.contrib.admin",
+       "django.contrib.auth",
+       "django.contrib.contenttypes",
+       "django.contrib.sessions",
+       "django.contrib.messages",
+       "django.contrib.staticfiles",
+
+       # your apps...
+   ]
+   ```
+
+2. Wire its URLs in front of the admin's own (it only adds two small JSON
+   endpoints under `admin/`, both `staff_member_required`):
+
+   ```python
+   from django.contrib import admin
+   from django.urls import include, path
+
+   urlpatterns = [
+       path("admin/", include("django_admin_modern_view.urls")),
+       path("admin/", admin.site.urls),
+   ]
+   ```
+
+3. Run the server. That's it — no changes to your `ModelAdmin` classes are
+   required. If something looks unstyled, run `python manage.py check`;
+   the bundled system check (`django_admin_modern_view.W001`) will tell you if the
+   `INSTALLED_APPS` order is the problem.
+
+## Configuration
+
+### Custom command palette entries
+
+```python
+# anywhere that runs at import time, e.g. your app's apps.py ready()
+from django_admin_modern_view.services.command_registry import register_command
+
+register_command(
+    id="reindex_search",
+    label="Rebuild search index",
+    category="Actions",
+    url="/admin/tools/reindex/",
+    icon="refresh",
+)
+```
+
+### Custom global search sources
+
+Any `ModelAdmin` with `search_fields` is picked up automatically. To search
+a model that isn't registered with the admin, or to use different fields
+than the admin search box does:
+
+```python
+from django_admin_modern_view.services.search import register_global_search
+from myapp.models import Order
+
+register_global_search(Order, fields=["reference", "customer__email"], label="Orders")
+```
+
+`search_fields` prefixes work the same way they do for `ModelAdmin`:
+`^field` (starts-with), `=field` (exact), `@field` (full-text), plain
+`field` (contains).
+
+## How it stays compatible
+
+This package only overrides two templates: `admin/base_site.html` (the
+shell every admin page extends) and `admin/index.html` (the dashboard).
+Change lists, change forms, inlines, filters, and actions are all still
+Django's own templates — this package only attaches CSS and progressive-
+enhancement JS to their existing, stable element IDs. That means:
+
+- Every `ModelAdmin` option (`list_display`, `list_filter`, `search_fields`,
+  `fieldsets`, `inlines`, `actions`, permissions) keeps working exactly as
+  configured.
+- The admin still works with JavaScript disabled — the extra chrome (command
+  palette, dirty-state indicator, keyboard nav) is progressive enhancement,
+  not a requirement.
+- No monkey-patching of `django.contrib.admin` internals.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE).

django_admin_modern_view-0.2.1/README.md

@@ -0,0 +1,159 @@
+# django-admin-modern-view
+
+A modern, keyboard-first UI layer for Django's built-in admin. Drop it into
+`INSTALLED_APPS`, keep your existing `ModelAdmin` classes exactly as they
+are, and the admin gets a command palette, global search, a real dashboard,
+and a reskinned shell — without giving up anything Django's admin already
+does for you (permissions, `list_filter`, inlines, actions, forms).
+
+This is **not** a fork of `django.contrib.admin` and it does not replace it.
+It ships two small template overrides (the shell + the dashboard) and pure
+CSS/JS progressive enhancement on top of the admin's existing, stable DOM
+(`#result_list`, `#changelist-filter`, `.submit-row`, `#nav-sidebar`, …).
+Every page Django's admin can render, it can still render with this
+installed — worst case you lose the extra chrome, you never lose function.
+
+## Features
+
+- **Command palette** (`Ctrl+K`) — fuzzy-search navigation and "create"
+  commands, generated from your admin site's registered models, plus a
+  `register_command()` API for anything custom.
+- **Global search** — searches every `ModelAdmin` that already defines
+  `search_fields` (zero config), permission-checked per model.
+- **Keyboard shortcuts** — `Ctrl+S`/`Ctrl+Shift+S` save, `J`/`K`/`Enter`/
+  `Space` to navigate and select change-list rows, `?` for a shortcut
+  cheat sheet, `Esc` closes whatever overlay is open.
+- **Enhanced change list** — sticky header, keyboard row navigation, and a
+  dropdown "Filters" panel built from your existing `list_filter`.
+- **Enhanced change form** — sticky save bar, dirty-state indicator,
+  unsaved-changes warning before navigating away.
+- **Dashboard** — per-model stat cards and collapsible per-app sections
+  (with model counts) in place of the plain default app list.
+- **Light/dark theme** — reskins Django's own built-in theme toggle; no
+  separate dark-mode system to maintain.
+- A system check that catches the #1 setup mistake (see below) instead of
+  failing silently.
+
+## Requirements
+
+- Django 5.1 or newer (uses the admin's built-in dark-mode theme toggle and
+  collapsible sidebar, both introduced in 5.1).
+- Python 3.10+.
+
+## Install
+
+```bash
+pip install django-admin-modern-view
+```
+
+Or, until it's published, install straight from GitHub:
+
+```bash
+pip install git+https://github.com/HItzz07/Django-adminkit.git
+```
+
+For local development against this repo:
+
+```bash
+pip install -e /path/to/django-admin-modern-view
+```
+
+## Quickstart
+
+1. Add it to `INSTALLED_APPS`, **before** `django.contrib.admin` — Django's
+   template loader resolves `admin/*.html` overrides by walking
+   `INSTALLED_APPS` in order and using the first match:
+
+   ```python
+   INSTALLED_APPS = [
+       "django_admin_modern_view",   # must come before django.contrib.admin
+
+       "django.contrib.admin",
+       "django.contrib.auth",
+       "django.contrib.contenttypes",
+       "django.contrib.sessions",
+       "django.contrib.messages",
+       "django.contrib.staticfiles",
+
+       # your apps...
+   ]
+   ```
+
+2. Wire its URLs in front of the admin's own (it only adds two small JSON
+   endpoints under `admin/`, both `staff_member_required`):
+
+   ```python
+   from django.contrib import admin
+   from django.urls import include, path
+
+   urlpatterns = [
+       path("admin/", include("django_admin_modern_view.urls")),
+       path("admin/", admin.site.urls),
+   ]
+   ```
+
+3. Run the server. That's it — no changes to your `ModelAdmin` classes are
+   required. If something looks unstyled, run `python manage.py check`;
+   the bundled system check (`django_admin_modern_view.W001`) will tell you if the
+   `INSTALLED_APPS` order is the problem.
+
+## Configuration
+
+### Custom command palette entries
+
+```python
+# anywhere that runs at import time, e.g. your app's apps.py ready()
+from django_admin_modern_view.services.command_registry import register_command
+
+register_command(
+    id="reindex_search",
+    label="Rebuild search index",
+    category="Actions",
+    url="/admin/tools/reindex/",
+    icon="refresh",
+)
+```
+
+### Custom global search sources
+
+Any `ModelAdmin` with `search_fields` is picked up automatically. To search
+a model that isn't registered with the admin, or to use different fields
+than the admin search box does:
+
+```python
+from django_admin_modern_view.services.search import register_global_search
+from myapp.models import Order
+
+register_global_search(Order, fields=["reference", "customer__email"], label="Orders")
+```
+
+`search_fields` prefixes work the same way they do for `ModelAdmin`:
+`^field` (starts-with), `=field` (exact), `@field` (full-text), plain
+`field` (contains).
+
+## How it stays compatible
+
+This package only overrides two templates: `admin/base_site.html` (the
+shell every admin page extends) and `admin/index.html` (the dashboard).
+Change lists, change forms, inlines, filters, and actions are all still
+Django's own templates — this package only attaches CSS and progressive-
+enhancement JS to their existing, stable element IDs. That means:
+
+- Every `ModelAdmin` option (`list_display`, `list_filter`, `search_fields`,
+  `fieldsets`, `inlines`, `actions`, permissions) keeps working exactly as
+  configured.
+- The admin still works with JavaScript disabled — the extra chrome (command
+  palette, dirty-state indicator, keyboard nav) is progressive enhancement,
+  not a requirement.
+- No monkey-patching of `django.contrib.admin` internals.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE).

django_admin_modern_view-0.2.1/pyproject.toml

@@ -0,0 +1,61 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "django-admin-modern-view"
+version = "0.2.1"
+description = "A modern, keyboard-first UI layer for Django's built-in admin — command palette, global search, dashboard, and more, on top of your existing ModelAdmin config."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [
+    { name = "Hitesh" },
+]
+keywords = ["django", "admin", "ui", "command-palette", "dashboard"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Framework :: Django",
+    "Framework :: Django :: 5.1",
+    "Framework :: Django :: 5.2",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "Django>=5.1,<6.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/HItzz07/Django-adminkit"
+Repository = "https://github.com/HItzz07/Django-adminkit"
+Issues = "https://github.com/HItzz07/Django-adminkit/issues"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4",
+    "pytest-django>=4.7",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["django_admin_modern_view*"]
+
+[tool.setuptools.package-data]
+django_admin_modern_view = [
+    "templates/admin/*.html",
+    "static/django_admin_modern_view/css/*.css",
+    "static/django_admin_modern_view/js/*.js",
+]
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "tests.settings"
+python_files = ["test_*.py"]
+pythonpath = ["."]

django_admin_modern_view-0.2.1/setup.cfg

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

django_admin_modern_view-0.2.1/src/django_admin_modern_view/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.1"

django_admin_modern_view-0.2.1/src/django_admin_modern_view/apps.py

@@ -0,0 +1,10 @@
+from django.apps import AppConfig
+
+
+class DjangoAdminModernViewConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "django_admin_modern_view"
+    verbose_name = "Django Admin Modern View"
+
+    def ready(self):
+        from . import checks  # noqa: F401  (registers Django system checks)

django_admin_modern_view-0.2.1/src/django_admin_modern_view/checks.py

@@ -0,0 +1,55 @@
+"""Django system checks that catch the one setup mistake this package
+can't work around: app ordering.
+
+Django's app_dirs template loader resolves ``admin/*.html`` overrides by
+walking INSTALLED_APPS in order and using the first match. If
+django_admin_modern_view isn't listed before django.contrib.admin, its template
+overrides silently lose to Django's own — the admin just looks
+unstyled, with no error to point at why.
+"""
+from django.apps import apps
+from django.conf import settings
+from django.core.checks import Warning, register
+
+
+@register()
+def check_app_order(app_configs, **kwargs):
+    installed = list(settings.INSTALLED_APPS)
+    try:
+        admin_index = next(
+            i for i, name in enumerate(installed)
+            if name == "django.contrib.admin" or name.startswith("django.contrib.admin.")
+        )
+    except StopIteration:
+        return []  # django.contrib.admin isn't installed; nothing to check
+
+    try:
+        our_index = next(
+            i for i, name in enumerate(installed)
+            if name == "django_admin_modern_view" or name.startswith("django_admin_modern_view.")
+        )
+    except StopIteration:
+        our_index = None  # resolved via AppConfig path instead of the bare name
+
+    if our_index is None:
+        try:
+            our_index = installed.index(apps.get_app_config("django_admin_modern_view").name)
+        except LookupError:
+            return []
+
+    if our_index > admin_index:
+        return [
+            Warning(
+                "django_admin_modern_view is listed after django.contrib.admin in "
+                "INSTALLED_APPS.",
+                hint=(
+                    "Move 'django_admin_modern_view' above 'django.contrib.admin' in "
+                    "INSTALLED_APPS. Django's template loader picks the "
+                    "first admin/*.html it finds by app order, so this "
+                    "package's overrides (topbar, command palette, dashboard) "
+                    "will otherwise be silently ignored."
+                ),
+                id="django_admin_modern_view.W001",
+            )
+        ]
+    return []

django_admin_modern_view-0.2.1/src/django_admin_modern_view/services/command_registry.py

@@ -0,0 +1,78 @@
+"""Central registry for the Modern Admin command palette (Ctrl+K).
+
+Commands are plain dicts so they serialize straight to JSON for the
+frontend. Registered commands are merged with commands auto-derived
+from the Django admin site (navigation + "create" actions) on every
+request, so palette content always reflects the logged-in user's
+permissions.
+"""
+from django.urls import reverse
+
+_registered_commands = []
+
+
+def register_command(id, label, category="General", shortcut=None, url=None, icon=None, keywords=""):
+    """Register a custom command shown in the command palette.
+
+    Example:
+        register_command(
+            id="create_user",
+            label="Create User",
+            category="Actions",
+            url="/admin/auth/user/add/",
+        )
+    """
+    _registered_commands.append({
+        "id": id,
+        "label": label,
+        "category": category,
+        "shortcut": shortcut,
+        "url": url,
+        "icon": icon or "",
+        "keywords": keywords,
+    })
+
+
+def get_registered_commands():
+    return list(_registered_commands)
+
+
+def get_commands_for_request(request):
+    """Build the full palette command list for the current user."""
+    from django.contrib import admin
+
+    commands = [{
+        "id": "nav:dashboard",
+        "label": "Dashboard",
+        "category": "Navigation",
+        "shortcut": None,
+        "url": reverse("admin:index"),
+        "icon": "home",
+        "keywords": "home dashboard",
+    }]
+
+    for app in admin.site.get_app_list(request):
+        for model in app["models"]:
+            if model.get("admin_url"):
+                commands.append({
+                    "id": f"nav:{app['app_label']}.{model['object_name']}",
+                    "label": model["name"],
+                    "category": "Navigation",
+                    "shortcut": None,
+                    "url": model["admin_url"],
+                    "icon": "list",
+                    "keywords": f"{app['name']} {model['name']}",
+                })
+            if model.get("add_url"):
+                commands.append({
+                    "id": f"create:{app['app_label']}.{model['object_name']}",
+                    "label": f"Create {model['name']}",
+                    "category": "Actions",
+                    "shortcut": None,
+                    "url": model["add_url"],
+                    "icon": "plus",
+                    "keywords": f"add new {model['name']}",
+                })
+
+    commands.extend(get_registered_commands())
+    return commands