Django Filtering UI
A Django app for providing a user interface (UI) to the
django-filtering
package.
The original usecase for the project's UI required the following:
- Does not disrupt existing backend rendered model listings
- provides the ability to filter on a field more than once
- provides the ability to toggle the filtering operation
(i.e.
AND,ORandNOTfilters operators) - provides the grouping of filters by operator (TODO)
- serializes UI filter data to JSON
- pre-validates UI filter data before sending to backend (TODO)
The UI is implemented in VueJS as a progressive web app (PWA). VueJS was used because of it's small footprint, ease of use, and progressive usage.
The UI implementation here in django-filtering-ui is separate from django-filtering
because there are multiple paths to implementing a frontend behavior.
I've choosen to create a PWA in VueJS,
but there is nothing stopping someone from developing a solution in htmx, React, JQuery, etc.
Installation
Install via pip or the preferred package manager:
pip install django-filtering-ui
Add this package to the installed apps list in your settings.
INSTALLED_APPS=[
#...
'django_filtering_ui',
]
See Usage for how to integrate into your frontend.
Usage
TODO
State of development
This package is very much a work-in-progress. All APIs are completely unstable.
Testing & development
Note, I'm testing within a docker container, because I never run anything locally. There are two containers, one for each language; Python for the backend and Node for the frontend. For the moment the containers is simply run with:
docker run -d --rm --name django-filtering-ui--frontend --workdir /code -v $PWD:/code -p 5173:5173 -p 9223:9223 node:latest sleep infinity
docker run -d --rm --name django-filtering-ui--backend --workdir /code -v $PWD:/code python:3.12 sleep infinity
Testing the frontend
Execute testing commands:
docker exec django-filtering-ui--frontend npm install
docker exec django-filtering-ui--frontend npm run test
Testing the backend
Execute testing commands:
docker exec django-filtering-ui--backend pip install -e ".[tests]"
docker exec django-filtering-ui--backend pytest
Using the debugger when testing the frontend
To use the chrome debugger use the following:
npm exec -- vitest --inspect-brk 0.0.0.0:9223 --no-file-parallelism -t "$TEST_NAME" $TEST_FILE
Then open chrome://inspect and 0.0.0.0:9223 as a network target.
Building for release
At this time the package is built as follows:
# Builds the js source and outputs it into src/django_filtering_ui/static
docker exec django-filtering-ui--frontend npm run build
# Build the python package files
docker exec django-filtering-ui--backend pip install hatchling
docker exec django-filtering-ui--backend hatchling build
License
GPL v3 (see LICENSE file)
Copyright
© 2026 The Shadowserver Foundation
Metadata
Release files for django-filtering-ui 0.0.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| django_filtering_ui-0.0.12.tar.gz | 99.1 kB | Without provenance | Details for django_filtering_ui-0.0.12.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| django_filtering_ui-0.0.12-py3-none-any.whl | Python 3 | none | any | Details for django_filtering_ui-0.0.12-py3-none-any.whl |
Total release size: 149.8 kB
Release files / django_filtering_ui-0.0.12.tar.gz
| Download URL | django_filtering_ui-0.0.12.tar.gz |
|---|---|
| Size | 99.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
80fd02aed317ffd41f45316f8e3755afe0f65d7f9bb1e1772d53592602195098
|
|
BLAKE2b-256 checksum How to use checksums |
171f3d24f00693c3684d5e8a8e7f4ddee37770f41c7030ca1303dd99a9848d6e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.3
|
Release files / django_filtering_ui-0.0.12-py3-none-any.whl
| Download URL | django_filtering_ui-0.0.12-py3-none-any.whl |
|---|---|
| Size | 50.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c02cd96d759d83a73d2a3dbb96b3a33836164fae2af346ed5d12837e1e37ec00
|
|
BLAKE2b-256 checksum How to use checksums |
020daa9f760f52ea0b0d13aaf93fee5a0886388b3fd484f786180d2bc51fa469
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.3
|
Security for django-filtering-ui 0.0.12
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.