Skip to main content

Finally a real searchkit for django!

Reason this release was yanked:

broken packaging

Project description

Welcome to django-searchkit

Description

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

You have tons of admin changelist filters and still you are not able to filter your items exactly as you need it? Or once and again you need a combination of several changelist filters and you are tired of waiting for each filter being applied one after the other? Or you just don't want to write a custom changelist filter for each special requirement of your customers.

Then django-searchkit is for you. Give it a try. You get a nice and handy formset to build complex searches with as many filter rules as you want over all of your model fields or the fields of related models.

Features

  • Build and apply complex searches using a dynamic formset with a ...
  • ...clear and easy to use layout.
  • Add as many filter rules as you want using django's various field lookups.
  • Chain filter rules by logical operators like AND or OR.
  • Filter over fields of related models.
  • Save and reuse your searches at any time by a handy admin changelist filter.

Setup

Install via pip:

pip install django-searchkit

Add searchkit to your INSTALLED_APPS:

INSTALLED_APPS = [
   'searchkit',
   ...
]

Include the searchkit.urls into your project urlpatterns:

urlpatterns = [
   path('searchkit/', include('searchkit.urls')),
   ...
]

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 the "Add search" button of the Searchkit filter.
  3. Give your Filter a name.
  4. Configure as many filter rules as you want.
  5. Click "Save and apply".
  6. Reuse your filter whenever you want using the Searchkit filter section.

Contribute

Contributions as feedback, feature requests, bug reports or pull requests are most welcome. Just use the common github infrastructure.

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-2.0.4.tar.gz (25.7 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-2.0.4-py3-none-any.whl (40.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for django_searchkit-2.0.4.tar.gz
Algorithm Hash digest
SHA256 c760c26eeb6e4c087b235c88a9524de0fad9b670ee158246dfa60969a99a8ad1
MD5 a70ccaedd619db4b332d97c180d18427
BLAKE2b-256 3fa534166c1db14c74d7b6d700cdcee8d340934739b2ed65bea8f74026090713

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_searchkit-2.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4c28db1085ffd466dc007680206d2b2c2ef58ac693a873f584e657dba2f25156
MD5 9b1a2f02d18d69fc669b66e0bc7ded9d
BLAKE2b-256 2c50cc65f4e33060f64b19a0f5fdc380043ac090a41020353b905f2e45aa8666

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