Skip to main content

Finally a real searchkit for django!

Project description

Welcome to django-searchkit

Description

Finally there is a real searchkit application for django that integrates best with the django admin backend.

Build and apply complex searches on model instances right in the backend without any coding. Save and reuse your searches by a handy django admin filter with a single click.

Setup

Install via pip:

pip install django-searchkit

Add searchkit to your INSTALLED_APPS:

INSTALLED_APPS = [
   'searchkit',
   ...
]

Add the SearkitFilter to your ModelAdmin:

from django.contrib import admin
from searchkit.filters import SearchkitFilter
from .models import MyModel


@admin.register(MyModel)
class MyModelAdmin(admin.ModelAdmin):
   ...
    list_filter = [
      SearchkitFilter,
      ...
      ]
   ...

Usage

  1. Open the admin changelist of your Model.
  2. Click "Add filter" on the Searchkit filter.
  3. Choose the Model you want to filter.
  4. Configure as many filter rules as you want.
  5. Click "Save and apply"

TODO

  • Limit the choices of the model field by models that should be searchable.
  • Add an apply button to the search edit page to be able to use a search without saving it.
  • Coming from the search edit page the filtering should be done by an id__in url parameter, not by an search parameter as it is used by the searchkit filter.
  • Preselect the right model in the model field when coming from a models changelist by the "Add filter" button.
  • Add a public field for searches and only offer public searches in the searchkit filter.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_searchkit-1.0.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_searchkit-1.0-py3-none-any.whl (40.3 kB view details)

Uploaded Python 3

File details

Details for the file django_searchkit-1.0.tar.gz.

File metadata

  • Download URL: django_searchkit-1.0.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for django_searchkit-1.0.tar.gz
Algorithm Hash digest
SHA256 f7d39ae84ac618bd04bddb727a29e5f434e4452ab6935341470e71fdf5c91b66
MD5 44574987acfb460ebc82eefb856ba843
BLAKE2b-256 60a899387e7ab8e684bf021d3a7d04fd5cf23333d5cedb7a84c77e06e8846498

See more details on using hashes here.

File details

Details for the file django_searchkit-1.0-py3-none-any.whl.

File metadata

  • Download URL: django_searchkit-1.0-py3-none-any.whl
  • Upload date:
  • Size: 40.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for django_searchkit-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 528f8f00ebe56eb97081a1b8a74eef0d006ec0ede170b2ade65fff83729b5afe
MD5 ebcf38fd32f8f8f71d9eb22a4894d19c
BLAKE2b-256 bb027e5bea8ba014b0a9e4706744546d58b435bc30b3ffed7d99c7b93f840845

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page