django-admin-superfilter 0.9.0__py3-none-any.whl

django_admin_superfilter-0.9.0.dist-info/METADATA

@@ -0,0 +1,348 @@
+Metadata-Version: 2.4
+Name: django-admin-superfilter
+Version: 0.9.0
+Summary: TODO
+License: MIT
+License-File: LICENCE.md
+Keywords: django,admin,filter,tools
+Author: Omar BENHAMID
+Author-email: omar.benhamid@smart-gts.com
+Requires-Python: >=3.10
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4
+Classifier: Framework :: Django :: 5
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Requires-Dist: django (>=4.0)
+Description-Content-Type: text/markdown
+
+# django-admin-superfilter
+
+Advanced, modern filtering for Django admin changelists, with saved filters and selectable columns.
+
+## Features
+
+- Search-bar style filter UI injected into Django admin changelists
+- Type-aware filtering for text, numeric, boolean, choice, date, datetime and relation fields
+- Field path traversal such as `author__email`
+- Saved filters per authenticated user
+- Column selection and ordering persisted with saved filters
+- AJAX-backed relation picker using Django admin Select2 assets
+- Support for custom filter fields via `SuperFilterField`
+- Single JSON query parameter for rules (`sf`) and one for visible columns (`sfc`)
+- Works without templates overrides
+
+## Requirements
+
+- Python 3.10+
+- Django 4.0+
+
+## Installation
+
+Install the package:
+
+```bash
+pip install django-admin-superfilter
+```
+
+Add the app to `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "superfilter",
+]
+```
+
+Run migrations:
+
+```bash
+python manage.py migrate
+```
+
+## Quick start
+
+```python
+from django.contrib import admin
+from superfilter.admin import SuperFilterAdminMixin
+
+from .models import Bird
+
+
+@admin.register(Bird)
+class BirdAdmin(SuperFilterAdminMixin, admin.ModelAdmin):
+    list_display = ("species", "location", "count")
+    search_fields = ("species",)
+```
+
+Important:
+
+- Put `SuperFilterAdminMixin` before `admin.ModelAdmin` in the MRO.
+- By default, filterable fields come from `list_display`.
+- Non-model entries in `list_display` are ignored.
+- Traversed model fields like `location__city__name` are supported.
+
+## What appears in the UI
+
+The package adds a search-bar-like control above the changelist with:
+
+- an add-filter button
+- filter badges for current rules
+- an Apply button
+- a split menu with Save
+- a Reset button
+- a Columns toggle button
+- a collapsible column chooser
+- saved filter chips
+
+Saved filters store both:
+
+- the active filter rules
+- the selected column list and order
+
+## Supported field kinds and operators
+
+### All fields
+
+- `set`
+- `not_set`
+
+### Text-like fields
+
+Text-like fields include `CharField`, `TextField`, `EmailField`, `SlugField`, `URLField`, `UUIDField`.
+
+Operators:
+
+- `set`
+- `not_set`
+- `eq`
+- `neq`
+- `contains`
+- `not_contains`
+- `in`
+- `not_in`
+
+### Numeric fields
+
+Operators:
+
+- `set`
+- `not_set`
+- `eq`
+- `neq`
+- `gt`
+- `lt`
+- `gte`
+- `lte`
+
+### Boolean fields
+
+Operators:
+
+- `set`
+- `not_set`
+- `true`
+- `false`
+
+### Choice fields
+
+Operators:
+
+- `set`
+- `not_set`
+- `in`
+- `not_in`
+
+### Foreign key / relation fields
+
+Operators:
+
+- `set`
+- `not_set`
+- `in`
+- `not_in`
+
+### Date and datetime fields
+
+Operators:
+
+- `set`
+- `not_set`
+- `eq`
+- `before`
+- `after`
+- `between`
+
+## Semantics
+
+- `set` means the field is considered populated
+- `not_set` means the field is empty
+- For text fields, empty means `NULL` or empty string
+- For boolean fields, `set` / `not_set` only target `NULL` vs non-`NULL`
+- `contains` uses `icontains`
+- `not_contains` negates `icontains`
+- `between` on date/datetime expects exactly two values
+- Relation filters use selected related object primary keys
+
+## Configuration
+
+`SuperFilterAdminMixin` exposes a few attributes:
+
+- `superfilter_param_name = "sf"`
+- `superfilter_columns_param_name = "sfc"`
+- `superfilter_fields = None`
+- `superfilter_page_size = 25`
+- `superfilter_all_limit = 2000`
+
+Example:
+
+```python
+class BirdAdmin(SuperFilterAdminMixin, admin.ModelAdmin):
+    list_display = ("species", "location", "count")
+    superfilter_page_size = 50
+    superfilter_all_limit = 5000
+```
+
+## Restricting filterable fields
+
+By default, filterable fields are taken from `list_display`.
+
+To expose a different set of fields, use `superfilter_fields`:
+
+```python
+class BirdAdmin(SuperFilterAdminMixin, admin.ModelAdmin):
+    list_display = ("species", "location", "count")
+    superfilter_fields = ("species", "count", "location__city")
+```
+
+This only affects filterable fields. Column selection still uses `list_display`.
+
+## Custom filter fields
+
+You can plug in custom fields that do not map directly to a Django model field.
+
+Create a subclass of `SuperFilterField`:
+
+```python
+from django.db.models import Q
+from superfilter.logic import SuperFilterField
+
+
+class HasLargeCountField(SuperFilterField):
+    path = "has_large_count"
+    label = "Large count"
+    kind = "choice"
+    choices = [
+        {"value": "yes", "label": "Yes"},
+        {"value": "no", "label": "No"},
+    ]
+
+    def apply_rule(self, queryset, rule):
+        values = set(rule.get("value") or [])
+        if "yes" in values and "no" not in values:
+            return queryset.filter(count__gte=100)
+        if "no" in values and "yes" not in values:
+            return queryset.filter(count__lt=100)
+        return queryset
+```
+
+Register it in `superfilter_fields`:
+
+```python
+class BirdAdmin(SuperFilterAdminMixin, admin.ModelAdmin):
+    list_display = ("species", "location", "count")
+    superfilter_fields = ("species", HasLargeCountField)
+```
+
+## Saved filters
+
+Saved filters are stored in the `SavedSuperFilter` model and are scoped by:
+
+- user
+- app label
+- model name
+- saved filter name
+
+Notes:
+
+- saving requires an authenticated user
+- saved filters are private to the user
+- the latest saved filter with column settings is used as fallback when `sfc` is absent from the querystring
+
+## URL format
+
+Rules are sent in the `sf` query parameter as JSON:
+
+```json
+[
+  {"field": "species", "op": "contains", "value": "owl"},
+  {"field": "location", "op": "in", "value": [1, 2]},
+  {"field": "count", "op": "gte", "value": 10}
+]
+```
+
+Columns are sent in the `sfc` query parameter as JSON:
+
+```json
+["location", "species", "count"]
+```
+
+## Relation option loading
+
+For relation filters, the package exposes an admin endpoint that:
+
+- reuses the related admin's `get_search_results()` when available
+- otherwise falls back to searching up to three text fields
+- otherwise falls back to PK search for numeric terms
+
+## Static assets
+
+The mixin injects:
+
+- `admin/css/vendor/select2/select2.min.css`
+- `admin/js/vendor/select2/select2.full.min.js`
+- `superfilter/superfilter.css`
+- `superfilter/superfilter.js`
+
+No custom template override is required.
+
+## Limitations
+
+- Filtering ignores callable/computed `list_display` entries unless implemented as `SuperFilterField`
+- Column selection only works on entries present in `list_display`
+- Saved filters depend on migrations for the `superfilter` app being applied
+- The package ships with admin-focused frontend assets and is not intended for non-admin pages
+
+## Example project
+
+A runnable sample project is available in:
+
+- `examples/sampleapp/`
+
+Run it with:
+
+```bash
+cd examples/sampleapp
+python manage.py migrate
+python manage.py runserver
+```
+
+## Development
+
+Run tests from the repository root:
+
+```bash
+python manage.py test superfilter
+```
+
+Or use the sample project:
+
+```bash
+cd examples/sampleapp
+python manage.py test
+```
+
+## License
+
+MIT. See `LICENCE.md`.
+

django_admin_superfilter-0.9.0.dist-info/RECORD

@@ -0,0 +1,21 @@
+superfilter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+superfilter/admin.py,sha256=vX6DEb4nocJuYOf6FkS7gRLY85l5V9fQJ35edVb6S6I,13957
+superfilter/apps.py,sha256=mJd5sqbZSUue9IbeUfJx5cy9J0JSAV3fWvP0nEkhSbQ,160
+superfilter/logic.py,sha256=vDs_HpWStY_3xoQcGJTUaVDP1TZj75rMYBYksFo_HhI,12525
+superfilter/migrations/0001_savedsuperfilter.py,sha256=9yxuI0oF-JERgZLRuBMfou7GhLd7FUG0SBSEj1kzYOE,1405
+superfilter/migrations/0002_savedsuperfilter_columns.py,sha256=rTYli7O7pT6S1-ltTRcIOxxYXt72jqYap6L794a1KQQ,377
+superfilter/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+superfilter/models.py,sha256=7p5vP2uhnp6ISelDRtCyQ53P4Umr1v4AFMx_GYH2-MI,872
+superfilter/static/superfilter/icons/add-filter.svg,sha256=Jb7wv7hxPFvmsfzEPBj8RptXCd6bMcWxUGiMLWwhEuw,446
+superfilter/static/superfilter/icons/columns.svg,sha256=ifFgsRIZjPOzadPJEZX1jgatCK1_L8pswcm7rm66V8U,477
+superfilter/static/superfilter/icons/reload.svg,sha256=ET_4GTe2VrTAmbLlLIQAufcjKfbQ2N9lNOP1UbUUi3o,626
+superfilter/static/superfilter/icons/trash.svg,sha256=EdXnbkJKKDInWA7E72_ddoKLfNrCRbTrPBQzUugzoe8,726
+superfilter/static/superfilter/icons/x-close.svg,sha256=ONCzp_yianACIill68DzVSchWvSzoKJmJd5AhLbnH7s,511
+superfilter/static/superfilter/superfilter.css,sha256=mAfCjvWyqIprttQqWyUxDfus_bZFDGImPqQTIqrRmbA,16319
+superfilter/static/superfilter/superfilter.js,sha256=W_Wr9K1Cmxz4DkJha4ekuisIJvEhJroLy_ioP5JrP_E,48983
+superfilter/tests.py,sha256=kCGiwY5rwXtggv-eopH9oGZgf3WF9-m2aD67lM8X_Zk,12681
+superfilter/views.py,sha256=u0FhL7RT5byf5IlcnZEMrcH2TOnQkdfRQU2SjtA26m0,66
+django_admin_superfilter-0.9.0.dist-info/licenses/LICENCE.md,sha256=6XF4HG1ozz-d48cvGtVphfLR6hYYr8cLQcP-KH4ft74,1089
+django_admin_superfilter-0.9.0.dist-info/METADATA,sha256=aNEX0SCLbH65zlEI35uyO-9kX8wjlVv51ManVk4DRFs,7441
+django_admin_superfilter-0.9.0.dist-info/WHEEL,sha256=EGEvSphFYqXKs23-kQBeyNoJP1nrT8ZJKQoi5p5DYL8,88
+django_admin_superfilter-0.9.0.dist-info/RECORD,,

django_admin_superfilter-0.9.0.dist-info/WHEEL

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

django_admin_superfilter-0.9.0.dist-info/licenses/LICENCE.md

@@ -0,0 +1,20 @@
+# MIT LICENCE
+Copyright (c) 2025 Omar BENHAMID
+
+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.