django-searchkit 0.1__tar.gz → 1.0__tar.gz

{django_searchkit-0.1/django_searchkit.egg-info → django_searchkit-1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-searchkit
-Version: 0.1
+Version: 1.0
 Summary: Finally a real searchkit for django!
 Home-page: https://github.com/thomst/django-searchkit
 Author: Thomas Leichtfuß
@@ -9,7 +9,6 @@ License: BSD License
 Platform: OS Independent
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Django
-Classifier: Framework :: Django :: 3.0
 Classifier: Framework :: Django :: 3.1
 Classifier: Framework :: Django :: 3.2
 Classifier: Framework :: Django :: 4.0
@@ -33,7 +32,8 @@ Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Description-Content-Type: text/markdown
 License-File: LICENCE
-Requires-Dist: Django>=3.0
+Requires-Dist: Django>=3.1
+Requires-Dist: django-picklefield>=2.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -51,12 +51,18 @@ Dynamic: summary
 [<img src="https://github.com/thomst/django-searchkit/actions/workflows/ci.yml/badge.svg">](https://github.com/thomst/django-searchkit/)
 [<img src="https://coveralls.io/repos/github/thomst/django-searchkit/badge.svg?branch=main">](https://coveralls.io/github/thomst/django-searchkit?branch=main)
 [<img src="https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue">](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
-[<img src="https://img.shields.io/badge/django-3.1%20%7C%203.2%20%7C%204.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1-orange">](https://img.shields.io/badge/django-3.1%20%7C%203.2%20%7C%204.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1-orange)
+[<img src="https://img.shields.io/badge/django-3.1%20%7C%203.2%20%7C%204.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1%20%7C%205.2-orange">](https://img.shields.io/badge/django-3.1%20%7C%203.2%20%7C%204.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1%20%7C%205.2-orange)
 
 
 ## Description
 
-TODO
+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
 
@@ -73,10 +79,40 @@ INSTALLED_APPS = [
 ]
 ```
 
-## Getting started
+Add the `SearkitFilter` to your `ModelAdmin`:
+```
+from django.contrib import admin
+from searchkit.filters import SearchkitFilter
+from .models import MyModel
 
-TODO
+
+@admin.register(MyModel)
+class MyModelAdmin(admin.ModelAdmin):
+   ...
+    list_filter = [
+      SearchkitFilter,
+      ...
+      ]
+   ...
+```
 
 ## Usage
 
-TODO
+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.

django_searchkit-1.0/README.md

@@ -0,0 +1,70 @@
+# Welcome to django-searchkit
+
+[<img src="https://github.com/thomst/django-searchkit/actions/workflows/ci.yml/badge.svg">](https://github.com/thomst/django-searchkit/)
+[<img src="https://coveralls.io/repos/github/thomst/django-searchkit/badge.svg?branch=main">](https://coveralls.io/github/thomst/django-searchkit?branch=main)
+[<img src="https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue">](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
+[<img src="https://img.shields.io/badge/django-3.1%20%7C%203.2%20%7C%204.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1%20%7C%205.2-orange">](https://img.shields.io/badge/django-3.1%20%7C%203.2%20%7C%204.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1%20%7C%205.2-orange)
+
+
+## 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.

{django_searchkit-0.1 → django_searchkit-1.0/django_searchkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-searchkit
-Version: 0.1
+Version: 1.0
 Summary: Finally a real searchkit for django!
 Home-page: https://github.com/thomst/django-searchkit
 Author: Thomas Leichtfuß
@@ -9,7 +9,6 @@ License: BSD License
 Platform: OS Independent
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Django
-Classifier: Framework :: Django :: 3.0
 Classifier: Framework :: Django :: 3.1
 Classifier: Framework :: Django :: 3.2
 Classifier: Framework :: Django :: 4.0
@@ -33,7 +32,8 @@ Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Description-Content-Type: text/markdown
 License-File: LICENCE
-Requires-Dist: Django>=3.0
+Requires-Dist: Django>=3.1
+Requires-Dist: django-picklefield>=2.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -51,12 +51,18 @@ Dynamic: summary
 [<img src="https://github.com/thomst/django-searchkit/actions/workflows/ci.yml/badge.svg">](https://github.com/thomst/django-searchkit/)
 [<img src="https://coveralls.io/repos/github/thomst/django-searchkit/badge.svg?branch=main">](https://coveralls.io/github/thomst/django-searchkit?branch=main)
 [<img src="https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue">](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
-[<img src="https://img.shields.io/badge/django-3.1%20%7C%203.2%20%7C%204.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1-orange">](https://img.shields.io/badge/django-3.1%20%7C%203.2%20%7C%204.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1-orange)
+[<img src="https://img.shields.io/badge/django-3.1%20%7C%203.2%20%7C%204.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1%20%7C%205.2-orange">](https://img.shields.io/badge/django-3.1%20%7C%203.2%20%7C%204.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1%20%7C%205.2-orange)
 
 
 ## Description
 
-TODO
+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
 
@@ -73,10 +79,40 @@ INSTALLED_APPS = [
 ]
 ```
 
-## Getting started
+Add the `SearkitFilter` to your `ModelAdmin`:
+```
+from django.contrib import admin
+from searchkit.filters import SearchkitFilter
+from .models import MyModel
 
-TODO
+
+@admin.register(MyModel)
+class MyModelAdmin(admin.ModelAdmin):
+   ...
+    list_filter = [
+      SearchkitFilter,
+      ...
+      ]
+   ...
+```
 
 ## Usage
 
-TODO
+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.

django_searchkit-1.0/django_searchkit.egg-info/requires.txt

@@ -0,0 +1,2 @@
+Django>=3.1
+django-picklefield>=2.0

{django_searchkit-0.1 → django_searchkit-1.0}/django_searchkit.egg-info/top_level.txt

@@ -1,3 +1,4 @@
+build
 dist
 example
 searchkit

{django_searchkit-0.1 → django_searchkit-1.0}/searchkit/__version__.py

@@ -13,4 +13,4 @@ Version 0.x should be considered a development version with an unstable API,
 and backwards compatibility is not guaranteed for minor versions.
 """
 
-__version__ = "0.1"
+__version__ = "1.0"

django_searchkit-1.0/searchkit/forms/__init__.py

@@ -0,0 +1,3 @@
+from .search import SearchkitSearchForm
+from .searchkit import SearchkitFormSet
+from .searchkit import SearchkitForm

{django_searchkit-0.1 → django_searchkit-1.0}/searchkit/forms/search.py

@@ -13,9 +13,6 @@ class SearchkitSearchForm(forms.ModelForm):
         model = SearchkitSearch
         fields = ['name']
 
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-
     @property
     def media(self):
         # TODO: Check if child classes inherit those media files.

{django_searchkit-0.1 → django_searchkit-1.0}/searchkit/forms/searchkit.py

@@ -56,7 +56,7 @@ class SearchkitForm(CSS_CLASSES, forms.Form):
                 # Do we have a valid value?
                 return self.fields[field_name].clean(self.unprefixed_data[field_name])
             except forms.ValidationError:
-                pass
+                return self.fields[field_name].choices[0][0]
         else:
             # At last simply return the first option which will be the selected
             # one.
@@ -115,7 +115,7 @@ class ContentTypeForm(CSS_CLASSES, forms.Form):
     Form to select a content type.
     """
     contenttype = forms.ModelChoiceField(
-        queryset=ContentType.objects.all(),
+        queryset=ContentType.objects.all(),  # FIXME: Limit choices to models that can be filtered.
         label=_('Model'),
         empty_label=_('Select a Model'),
         widget=forms.Select(attrs={"class": CSS_CLASSES.reload_on_change_css_class}),
@@ -140,26 +140,23 @@ class BaseSearchkitFormset(CSS_CLASSES, forms.BaseFormSet):
     contenttype_form_class = ContentTypeForm
 
     def __init__(self, *args, **kwargs):
-        self.contenttype_form = self.get_conttenttype_form(kwargs)
-        self.model = self.get_model(kwargs)
+        self.model = kwargs.pop('model', None)
         super().__init__(*args, **kwargs)
+        self.contenttype_form = self.get_conttenttype_form(kwargs)
+        if not self.model and self.contenttype_form.is_valid():
+            self.model = self.contenttype_form.cleaned_data.get('contenttype').model_class()
         if self.initial:
             self.extra = 0
 
     def get_conttenttype_form(self, kwargs):
         ct_kwargs = dict()
-        ct_kwargs['data'] = kwargs.get('data')
-        ct_kwargs['prefix'] = kwargs.get('prefix')
-        if model := kwargs.pop('model', None):
-            ct_kwargs['initial'] = dict(contenttype=ContentType.objects.get_for_model(model))
+        ct_kwargs['data'] = self.data or None
+        ct_kwargs['prefix'] = self.prefix
+        if self.model:
+            contenttype = ContentType.objects.get_for_model(self.model)
+            ct_kwargs['initial'] = dict(contenttype=contenttype)
         return self.contenttype_form_class(**ct_kwargs)
 
-    def get_model(self, kwargs):
-        if self.contenttype_form.initial:
-            return self.contenttype_form.initial['contenttype'].model_class()
-        elif self.contenttype_form.is_valid():
-            return self.contenttype_form.cleaned_data['contenttype'].model_class()
-
     def get_form_kwargs(self, index):
         kwargs = self.form_kwargs.copy()
         kwargs['model'] = self.model

django_searchkit-1.0/searchkit/tests.py

@@ -0,0 +1,250 @@
+from django.test import TestCase
+from django.contrib.contenttypes.models import ContentType
+from django import forms
+from example.models import ModelA
+from searchkit.forms.utils import FIELD_PLAN
+from searchkit.forms.utils import SUPPORTED_FIELDS
+from searchkit.forms.utils import SUPPORTED_RELATIONS
+from searchkit.forms import SearchkitSearchForm
+from searchkit.forms import SearchkitForm
+from searchkit.forms import SearchkitFormSet
+
+
+INITIAL_DATA = [
+    dict(
+        field='model_b__chars',
+        operator='exact',
+        value='anytext',
+    ),
+    dict(
+        field='integer',
+        operator='range',
+        value=[1, 123],
+    ),
+    dict(
+        field='float',
+        operator='exact',
+        value='0.3',
+    ),
+    dict(
+        field='decimal',
+        operator='exact',
+        value='1.23',
+    ),
+    dict(
+        field='date',
+        operator='exact',
+        value='2025-05-14',
+    ),
+    dict(
+        field='datetime',
+        operator='exact',
+        value='2025-05-14 08:45',
+    )
+]
+
+add_prefix = lambda i: SearchkitFormSet(model=ModelA).add_prefix(i)
+DEFAULT_PREFIX = SearchkitFormSet.get_default_prefix()
+FORM_DATA = {
+    'name': 'test search',                  # The name of the search.
+    f'{DEFAULT_PREFIX}-TOTAL_FORMS': '6',   # Data for the managment form.
+    f'{DEFAULT_PREFIX}-INITIAL_FORMS': '1', # Data for the managment form.
+    f'{DEFAULT_PREFIX}-contenttype': f'{ContentType.objects.get_for_model(ModelA).pk}',
+    f'{add_prefix(1)}-value_0': '1',        # Data for the range operator.
+    f'{add_prefix(1)}-value_1': '123',      # Data for the range operator.
+}
+for i, data in enumerate(INITIAL_DATA, 0):
+    prefix = SearchkitFormSet(model=ModelA).add_prefix(i)
+    for key, value in data.items():
+        FORM_DATA.update({f'{prefix}-{key}': value})
+
+
+class CheckFormMixin:
+    """
+    Mixin to check the form fields and their choices.
+    """
+    def check_form(self, form):
+        # Three fields should be generated on instantiation.
+        self.assertIn('field', form.fields)
+        self.assertIn('operator', form.fields)
+        self.assertIn('value', form.fields)
+        self.assertEqual(len(form.fields), 3)
+
+        # Check choices of the model_field.
+        form_model_field = form.fields['field']
+        self.assertTrue(form_model_field.choices)
+        options = [c[0] for c in form_model_field.choices]
+        for model_field in ModelA._meta.fields:
+            if isinstance(model_field, tuple(SUPPORTED_FIELDS)):
+                self.assertIn(model_field.name, options)
+
+        # Check choices for relational lookups.
+        for model_field in ModelA._meta.fields:
+            if isinstance(model_field, tuple(SUPPORTED_RELATIONS)):
+                remote_fields = model_field.remote_field.model._meta.fields
+                for remote_field in remote_fields:
+                    if isinstance(model_field, tuple(SUPPORTED_FIELDS)):
+                        lookup_path = f'{model_field.name}__{remote_field.name}'
+                        self.assertIn(lookup_path, options)
+
+        # Check the field_plan choosen based on the model_field.
+        field_plan = next(iter([p for t, p in FIELD_PLAN.items() if t(form.model_field)]))
+        self.assertEqual(form.field_plan, field_plan)
+
+        # Check choices of the operator field based on the field_plan.
+        operator_field = form.fields['operator']
+        self.assertTrue(operator_field.choices)
+        self.assertEqual(len(operator_field.choices), len(form.field_plan))
+        for operator in form.field_plan.keys():
+            self.assertIn(operator, [c[0] for c in operator_field.choices])
+
+
+class SearchkitFormTestCase(CheckFormMixin, TestCase):
+
+    def test_blank_searchkitform(self):
+        form = SearchkitForm(ModelA, prefix=add_prefix(0))
+        self.check_form(form)
+
+        # Form should not be bound or valid.
+        self.assertFalse(form.is_bound)
+        self.assertFalse(form.is_valid())
+
+    def test_searchkitform_with_invalid_model_field_data(self):
+        data = {
+            f'{add_prefix(0)}-field': 'foobar',
+        }
+        form = SearchkitForm(ModelA, data, prefix=add_prefix(0))
+        self.check_form(form)
+
+        # Form should be invalid.
+        self.assertFalse(form.is_valid())
+
+        # Check error message in html.
+        errors = ['Select a valid choice. foobar is not one of the available choices.']
+        self.assertIn(errors, form.errors.values())
+
+    def test_searchkitform_with_valid_model_field_data(self):
+        data = {
+            f'{add_prefix(0)}-field': 'integer',
+        }
+        form = SearchkitForm(ModelA, data, prefix=add_prefix(0))
+        self.check_form(form)
+
+        # Form should be invalid since no value data is provieded.
+        self.assertFalse(form.is_valid())
+
+    def test_searchkitform_with_invalid_operator_data(self):
+        data = {
+            f'{add_prefix(0)}-field': 'integer',
+            f'{add_prefix(0)}-operator': 'foobar',
+        }
+        form = SearchkitForm(ModelA, data, prefix=add_prefix(0))
+        self.check_form(form)
+
+        # Form should be invalid.
+        self.assertFalse(form.is_valid())
+
+        # Check error message in html.
+        errors = ['Select a valid choice. foobar is not one of the available choices.']
+        self.assertIn(errors, form.errors.values())
+
+    def test_searchkitform_with_valid_operator_data(self):
+        data = {
+            f'{add_prefix(0)}-field': 'integer',
+            f'{add_prefix(0)}-operator': 'exact',
+        }
+        form = SearchkitForm(ModelA, data, prefix=add_prefix(0))
+        self.check_form(form)
+
+        # Form should be invalid since no value data is provieded.
+        self.assertFalse(form.is_valid())
+
+    def test_searchkitform_with_valid_data(self):
+        data = {
+            f'{add_prefix(0)}-field': 'integer',
+            f'{add_prefix(0)}-operator': 'exact',
+            f'{add_prefix(0)}-value': '123',
+        }
+        form = SearchkitForm(ModelA, data, prefix=add_prefix(0))
+        self.check_form(form)
+
+        # Form should be valid.
+        self.assertTrue(form.is_valid())
+
+    def test_searchkitform_with_invalid_data(self):
+        data = {
+            f'{add_prefix(0)}-field': 'integer',
+            f'{add_prefix(0)}-operator': 'exact',
+            f'{add_prefix(0)}-value': 'foobar',
+        }
+        form = SearchkitForm(ModelA, data, prefix=add_prefix(0))
+        self.check_form(form)
+
+        # Form should be invalid.
+        self.assertFalse(form.is_valid())
+
+        # Check error message in html.
+        errors = ['Enter a whole number.']
+        self.assertIn(errors, form.errors.values())
+
+
+class SearchkitFormSetTestCase(CheckFormMixin, TestCase):
+    def test_blank_searchkitform(self):
+        # Instantiating the formset neither with a model instance nor with model
+        # related data or initial data should result in a formset without forms,
+        # that is invalid and unbound.
+        formset = SearchkitFormSet()
+        self.assertFalse(formset.is_bound)
+        self.assertFalse(formset.is_valid())
+
+    def test_searchkit_formset_with_valid_data(self):
+        formset = SearchkitFormSet(FORM_DATA)
+        self.assertTrue(formset.is_valid())
+
+    def test_searchkit_formset_with_invalid_data(self):
+        data = FORM_DATA.copy()
+        del data[f'{add_prefix(0)}-value']
+        formset = SearchkitFormSet(data, model=ModelA)
+        self.assertFalse(formset.is_valid())
+
+        # Check error message in html.
+        errors = ['This field is required.']
+        self.assertIn(errors, formset.forms[0].errors.values())
+
+    def test_searchkit_formset_with_initial_data(self):
+        formset = SearchkitFormSet(initial=INITIAL_DATA, model=ModelA)
+        self.assertFalse(formset.is_bound)
+        self.assertFalse(formset.is_valid())
+        self.assertEqual(len(formset.forms), len(INITIAL_DATA))
+        for i, form in enumerate(formset.forms):
+            self.assertEqual(form.initial, INITIAL_DATA[i])
+            self.check_form(form)
+
+
+class SearchkitSearchFormTestCase(TestCase):
+    def test_searchkit_search_form_without_data(self):
+        form = SearchkitSearchForm()
+        self.assertFalse(form.is_bound)
+        self.assertFalse(form.is_valid())
+        self.assertIsInstance(form.formset, SearchkitFormSet)
+        self.assertEqual(form.formset.model, None)
+
+    def test_searchkit_search_form_with_data(self):
+        form = SearchkitSearchForm(FORM_DATA)
+        self.assertTrue(form.is_bound)
+        self.assertTrue(form.is_valid())
+        self.assertIsInstance(form.formset, SearchkitFormSet)
+        self.assertEqual(form.formset.model, ModelA)
+        self.assertEqual(form.instance.data, form.formset.cleaned_data)
+
+        # Saving the instance works.
+        form.instance.save()
+        self.assertTrue(form.instance.pk)
+
+        # Using the instance data as filter rules works.
+        filter_rules = form.instance.get_filter_rules()
+        self.assertEqual(len(filter_rules), len(INITIAL_DATA))
+        for data in INITIAL_DATA:
+            self.assertIn(f"{data['field']}__{data['operator']}", filter_rules)
+        queryset = form.formset.model.objects.filter(**filter_rules)
+        self.assertTrue(queryset.model == ModelA)

{django_searchkit-0.1 → django_searchkit-1.0}/setup.py

@@ -43,12 +43,12 @@ setup(
     packages=find_namespace_packages(exclude=["example"]),
     include_package_data=True,
     install_requires=[
-        "Django>=3.0",
+        "Django>=3.1",
+        "django-picklefield>=2.0",
     ],
     classifiers=[
         dev_status,
         "Framework :: Django",
-        "Framework :: Django :: 3.0",
         "Framework :: Django :: 3.1",
         "Framework :: Django :: 3.2",
         "Framework :: Django :: 4.0",

django_searchkit-0.1/README.md

@@ -1,34 +0,0 @@
-# Welcome to django-searchkit
-
-[<img src="https://github.com/thomst/django-searchkit/actions/workflows/ci.yml/badge.svg">](https://github.com/thomst/django-searchkit/)
-[<img src="https://coveralls.io/repos/github/thomst/django-searchkit/badge.svg?branch=main">](https://coveralls.io/github/thomst/django-searchkit?branch=main)
-[<img src="https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue">](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
-[<img src="https://img.shields.io/badge/django-3.1%20%7C%203.2%20%7C%204.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1-orange">](https://img.shields.io/badge/django-3.1%20%7C%203.2%20%7C%204.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1-orange)
-
-
-## Description
-
-TODO
-
-## Setup
-
-Install via pip:
-```
-pip install django-searchkit
-```
-
-Add `searchkit` to your `INSTALLED_APPS`:
-```
-INSTALLED_APPS = [
-   'searchkit',
-   ...
-]
-```
-
-## Getting started
-
-TODO
-
-## Usage
-
-TODO

django_searchkit-0.1/django_searchkit.egg-info/requires.txt

@@ -1 +0,0 @@
-Django>=3.0

django_searchkit-0.1/searchkit/forms/__init__.py

@@ -1,2 +0,0 @@
-from .search import SearchkitSearchForm
-from .searchkit import SearchkitFormSet

django_searchkit-0.1/searchkit/tests.py

@@ -1,197 +0,0 @@
-from django.test import TestCase
-from django import forms
-from example.models import ModelA
-from .searchkit import FIELD_PLAN
-from .searchkit import SearchkitForm
-from .searchkit import SearchkitFormSet
-
-
-INITIAL_DATA = [
-    dict(
-        field='chars',
-        operator='exact',
-        value='anytext',
-    ),
-    dict(
-        field='integer',
-        operator='range',
-        value_0=1,
-        value_1=123,
-    ),
-    dict(
-        field='float',
-        operator='exact',
-        value='0.3',
-    ),
-    dict(
-        field='decimal',
-        operator='exact',
-        value='1.23',
-    ),
-    dict(
-        field='date',
-        operator='exact',
-        value='2025-05-14',
-    ),
-    dict(
-        field='datetime',
-        operator='exact',
-        value='2025-05-14 08:45',
-    )
-]
-
-DEFAULT_PREFIX = SearchkitFormSet.get_default_prefix()
-FORM_DATA = {
-    f'{DEFAULT_PREFIX}-TOTAL_FORMS': '6',
-    f'{DEFAULT_PREFIX}-INITIAL_FORMS': '1'
-}
-for i, data in enumerate(INITIAL_DATA):
-    for key, value in data.items():
-        FORM_DATA.update({f'{DEFAULT_PREFIX}-{i}-{key}': value})
-
-
-class SearchkitFormTestCase(TestCase):
-
-    def check_form(self, form):
-        # Three fields should be generated on instantiation.
-        self.assertIn('field', form.fields)
-        self.assertIn('operator', form.fields)
-        self.assertIn('value', form.fields)
-        self.assertEqual(len(form.fields), 3)
-
-        # Check choices of the model_field.
-        form_model_field = form.fields['field']
-        self.assertTrue(form_model_field.choices)
-        self.assertEqual(len(form_model_field.choices), len(ModelA._meta.fields))
-        for model_field in ModelA._meta.fields:
-            self.assertIn(model_field.name, [c[0] for c in form_model_field.choices])
-
-        # Check the field_plan choosen based on the model_field.
-        field_plan = next(iter([p for t, p in FIELD_PLAN.items() if t(form.model_field)]))
-        self.assertEqual(form.field_plan, field_plan)
-
-        # Check choices of the operator field based on the field_plan.
-        operator_field = form.fields['operator']
-        self.assertTrue(operator_field.choices)
-        self.assertEqual(len(form_model_field.choices), len(form.field_plan))
-        for operator in form.field_plan.keys():
-            self.assertIn(operator, [c[0] for c in operator_field.choices])
-
-
-    def test_blank_searchkitform(self):
-        for index in range(3):
-            prefix = SearchkitFormSet(ModelA).add_prefix(index)
-            form = SearchkitForm(ModelA, prefix=prefix)
-            self.check_form(form)
-
-            # Form should not be bound or valid.
-            self.assertFalse(form.is_bound)
-            self.assertFalse(form.is_valid())
-
-    def test_searchkitform_with_invalid_model_field_data(self):
-        prefix = SearchkitFormSet(ModelA).add_prefix(0)
-        data = {
-            f'{prefix}-field': 'foobar',
-        }
-        form = SearchkitForm(ModelA, data, prefix=prefix)
-        self.check_form(form)
-
-        # Form should be invalid.
-        self.assertFalse(form.is_valid())
-
-        # Check error message in html.
-        errors = ['Select a valid choice. foobar is not one of the available choices.']
-        self.assertFormError(form, 'field', errors)
-
-    def test_searchkitform_with_valid_model_field_data(self):
-        prefix = SearchkitFormSet(ModelA).add_prefix(0)
-        data = {
-            f'{prefix}-field': 'integer',
-        }
-        form = SearchkitForm(ModelA, data, prefix=prefix)
-        self.check_form(form)
-
-        # Form should be invalid.
-        self.assertFalse(form.is_valid())
-
-    def test_searchkitform_with_invalid_operator_data(self):
-        prefix = SearchkitFormSet(ModelA).add_prefix(0)
-        data = {
-            f'{prefix}-field': 'integer',
-            f'{prefix}-operator': 'foobar',
-        }
-        form = SearchkitForm(ModelA, data, prefix=prefix)
-        self.check_form(form)
-
-        # Form should be invalid.
-        self.assertFalse(form.is_valid())
-
-        # Check error message in html.
-        errors = ['Select a valid choice. foobar is not one of the available choices.']
-        self.assertFormError(form, 'operator', errors)
-
-    def test_searchkitform_with_valid_operator_data(self):
-        prefix = SearchkitFormSet(ModelA).add_prefix(0)
-        data = {
-            f'{prefix}-field': 'integer',
-            f'{prefix}-operator': 'exact',
-        }
-        form = SearchkitForm(ModelA, data, prefix=prefix)
-        self.check_form(form)
-
-        # Form should be invalid.
-        self.assertFalse(form.is_valid())
-
-    def test_searchkitform_with_valid_data(self):
-        prefix = SearchkitFormSet(ModelA).add_prefix(0)
-        data = {
-            f'{prefix}-field': 'integer',
-            f'{prefix}-operator': 'exact',
-            f'{prefix}-value': '123',
-        }
-        form = SearchkitForm(ModelA, data, prefix=prefix)
-        self.check_form(form)
-
-        # Form should be valid, bound and complete
-        self.assertTrue(form.is_valid())
-
-        # Get filter rule and check if a lookup does not raises any error.
-        rule = form.get_filter_rule()
-        self.assertFalse(ModelA.objects.filter(**dict((rule,))))
-
-    def test_searchkitform_with_invalid_data(self):
-        prefix = SearchkitFormSet(ModelA).add_prefix(0)
-        data = {
-            f'{prefix}-field': 'integer',
-            f'{prefix}-operator': 'exact',
-            f'{prefix}-value': 'foobar',
-        }
-        form = SearchkitForm(ModelA, data, prefix=prefix)
-        self.check_form(form)
-
-        # Form should be invalid.
-        self.assertFalse(form.is_valid())
-
-        # Check error message in html.
-        errors = ['Enter a whole number.']
-        self.assertFormError(form, 'value', errors)
-
-        # get_filter_rule should raise an error.
-        with self.assertRaises(forms.ValidationError):
-            form.get_filter_rule()
-
-
-class SearchkitFormSetTestCase(TestCase):
-
-    def test_searchkit_formset_with_valid_data(self):
-        formset = SearchkitFormSet(ModelA, FORM_DATA)
-        self.assertTrue(formset.is_valid())
-
-        # Just check if the filter rules are applicable. Result should be empty.
-        self.assertFalse(ModelA.objects.filter(**formset.get_filter_rules()))
-
-    def test_searchkit_formset_with_incomplete_data(self):
-        data = FORM_DATA.copy()
-        del data[f'{DEFAULT_PREFIX}-0-value']
-        formset = SearchkitFormSet(ModelA, data)
-        self.assertFalse(formset.is_valid())