django-searchkit 0.1__py3-none-any.whl → 1.0__py3-none-any.whl

build/lib/example/example/admin.py

@@ -0,0 +1,16 @@
+from django.contrib import admin
+from searchkit.filters import SearchkitFilter
+from .models import ModelA
+from .models import ModelB
+
+
+@admin.register(ModelA)
+class ModelAAdmin(admin.ModelAdmin):
+    list_display = [f.name for f in ModelA._meta.fields]
+    list_filter = [SearchkitFilter, 'chars_choices']
+
+
+@admin.register(ModelB)
+class ModelBAdmin(admin.ModelAdmin):
+    list_display = [f.name for f in ModelB._meta.fields]
+    list_filter = [SearchkitFilter]

build/lib/example/example/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for example project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.1/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'example.settings')
+
+application = get_asgi_application()

build/lib/example/example/management/commands/createtestdata.py

@@ -0,0 +1,62 @@
+import random
+from datetime import timedelta
+from decimal import Decimal
+from django.utils import timezone
+from django.core.management.base import BaseCommand
+from django.contrib.auth.models import User
+from example.models import ModelA, ModelB, CHARS_CHOICES, INTEGER_CHOICES
+
+
+class Command(BaseCommand):
+    help = 'Generate test data for ModelA and ModelB'
+
+    def handle(self, *args, **kwargs):
+        self.stdout.write("Creating test data...")
+
+        # Create a superuser
+        if not User.objects.filter(username='admin').exists():
+            User.objects.create_superuser(
+                username='admin',
+                email='admin@example.com',
+                password='adminpassword'
+            )
+            self.stdout.write(self.style.SUCCESS("Superuser 'admin' created successfully!"))
+        else:
+            self.stdout.write(self.style.WARNING("Superuser 'admin' already exists."))
+
+        # Generate test data for ModelA
+        model_a_instances = []
+        for i in range(10):
+            model_a = ModelA.objects.create(
+                boolean=random.choice([None, True, False]),
+                chars=f"ModelA_Chars_{i}",
+                chars_choices=random.choice([c[0] for c in CHARS_CHOICES]),
+                integer=random.randint(1, 100),
+                integer_choices=random.choice([c[0] for c in INTEGER_CHOICES]),
+                float=random.uniform(1.0, 100.0),
+                decimal=Decimal(f"{random.randint(1, 100)}.{random.randint(0, 99)}"),
+                date=timezone.now().date() - timedelta(days=random.randint(0, 365)),  # Use timezone.now()
+                datetime=timezone.now() - timedelta(days=random.randint(0, 365))  # Use timezone.now()
+            )
+            model_a_instances.append(model_a)
+
+        # Generate test data for ModelB
+        model_b_instances = []
+        for i in range(10):
+            model_b = ModelB.objects.create(
+                chars=f"ModelB_Chars_{i}",
+                integer=random.randint(1, 100),
+                float=random.uniform(1.0, 100.0),
+                decimal=Decimal(f"{random.randint(1, 100)}.{random.randint(0, 99)}"),
+                date=timezone.now().date() - timedelta(days=random.randint(0, 365)),  # Use timezone.now()
+                datetime=timezone.now() - timedelta(days=random.randint(0, 365)),  # Use timezone.now()
+                model_a=random.choice(model_a_instances)
+            )
+            model_b_instances.append(model_b)
+
+        # Add modela -> modelb relation.
+        for index, model_a in enumerate(model_a_instances):
+            model_a.model_b = model_b_instances[index]
+            model_a.save()
+
+        self.stdout.write(self.style.SUCCESS("Test data created successfully!"))

build/lib/example/example/migrations/0001_initial.py

@@ -0,0 +1,48 @@
+# Generated by Django 5.1.3 on 2025-05-25 05:46
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='ModelA',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('boolean', models.BooleanField(null=True)),
+                ('chars', models.CharField(max_length=255)),
+                ('chars_choices', models.CharField(choices=[('one', 'One'), ('two', 'Two'), ('three', 'Three'), ('four', 'Four')], max_length=255)),
+                ('integer', models.IntegerField()),
+                ('integer_choices', models.IntegerField(choices=[(1, 1), (2, 2), (3, 3), (4, 4)])),
+                ('float', models.FloatField()),
+                ('decimal', models.DecimalField(decimal_places=2, max_digits=5)),
+                ('date', models.DateField()),
+                ('datetime', models.DateTimeField()),
+            ],
+        ),
+        migrations.CreateModel(
+            name='ModelB',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('chars', models.CharField(max_length=255)),
+                ('integer', models.IntegerField()),
+                ('float', models.FloatField()),
+                ('decimal', models.DecimalField(decimal_places=2, max_digits=5)),
+                ('date', models.DateField()),
+                ('datetime', models.DateTimeField()),
+                ('model_a', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='example.modela')),
+            ],
+        ),
+        migrations.AddField(
+            model_name='modela',
+            name='model_b',
+            field=models.OneToOneField(null=True, on_delete=django.db.models.deletion.CASCADE, to='example.modelb'),
+        ),
+    ]

build/lib/example/example/models.py

@@ -0,0 +1,38 @@
+from django.db import models
+
+
+CHARS_CHOICES = (
+    ('one', 'One'),
+    ('two', 'Two'),
+    ('three', 'Three'),
+    ('four', 'Four'),
+)
+INTEGER_CHOICES = (
+    (1, 1),
+    (2, 2),
+    (3, 3),
+    (4, 4),
+)
+
+
+class ModelA(models.Model):
+    boolean = models.BooleanField(null=True)
+    chars = models.CharField(max_length=255)
+    chars_choices = models.CharField(max_length=255, choices=CHARS_CHOICES)
+    integer = models.IntegerField()
+    integer_choices = models.IntegerField(choices=INTEGER_CHOICES)
+    float = models.FloatField()
+    decimal = models.DecimalField(max_digits=5, decimal_places=2)
+    date = models.DateField()
+    datetime = models.DateTimeField()
+    model_b = models.OneToOneField('ModelB', on_delete=models.CASCADE, null=True)
+
+
+class ModelB(models.Model):
+    chars = models.CharField(max_length=255)
+    integer = models.IntegerField()
+    float = models.FloatField()
+    decimal = models.DecimalField(max_digits=5, decimal_places=2)
+    date = models.DateField()
+    datetime = models.DateTimeField()
+    model_a = models.ForeignKey(ModelA, on_delete=models.CASCADE)

build/lib/example/example/settings.py

@@ -0,0 +1,125 @@
+"""
+Django settings for example project.
+
+Generated by 'django-admin startproject' using Django 4.1.6.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.1/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.1/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/4.1/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'django-insecure-^@et7v8l)mu@#@tooytj77v&jtkqy&i^wgp9+ro&v!rb6f1y__'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'example',
+    'searchkit',
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'example.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'example.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/4.1/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.1/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/4.1/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/4.1/howto/static-files/
+
+STATIC_URL = 'static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.1/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

build/lib/example/example/urls.py

@@ -0,0 +1,23 @@
+"""example URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/4.1/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path, include
+
+
+urlpatterns = [
+    path('', include('searchkit.urls')),
+    path('admin/', admin.site.urls),
+]

build/lib/example/example/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for example project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.1/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'example.settings')
+
+application = get_wsgi_application()

build/lib/searchkit/__version__.py

@@ -0,0 +1,16 @@
+"""
+This project uses the Semantic Versioning scheme in conjunction with PEP 0440:
+    <http://semver.org/>
+    <https://www.python.org/dev/peps/pep-0440>
+
+Major versions introduce significant changes to the API, and backwards
+compatibility is not guaranteed. Minor versions are for new features and other
+backwards-compatible changes to the API. Patch versions are for bug fixes and
+internal code changes that do not affect the API. Development versions are
+incomplete states of a release .
+
+Version 0.x should be considered a development version with an unstable API,
+and backwards compatibility is not guaranteed for minor versions.
+"""
+
+__version__ = "1.0"

build/lib/searchkit/admin.py

@@ -0,0 +1,30 @@
+from django.contrib import admin
+from django.http import HttpResponseRedirect
+from django.urls import reverse
+from .models import SearchkitSearch
+from .forms import SearchkitSearchForm
+from .filters import SearchkitFilter
+
+
+@admin.register(SearchkitSearch)
+class SearchkitSearchAdmin(admin.ModelAdmin):
+    form = SearchkitSearchForm
+    list_display = ('name', 'contenttype', 'created_date')
+
+    def get_url_for_applied_search(self, obj):
+        app_label = obj.contenttype.app_label
+        model_name = obj.contenttype.model
+        base_url = reverse(f'admin:{app_label}_{model_name}_changelist')
+        return f'{base_url}?{SearchkitFilter.parameter_name}={obj.pk}'
+
+    def response_add(self, request, obj, *args, **kwargs):
+        if '_save_and_apply' in request.POST:
+            return HttpResponseRedirect(self.get_url_for_applied_search(obj))
+        else:
+            return super().response_add(request, obj, *args, **kwargs)
+
+    def response_change(self, request, obj, *args, **kwargs):
+        if '_save_and_apply' in request.POST:
+            return HttpResponseRedirect(self.get_url_for_applied_search(obj))
+        else:
+            return super().response_change(request, obj, *args, **kwargs)

build/lib/searchkit/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class SearchkitConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'searchkit'

build/lib/searchkit/filters.py

@@ -0,0 +1,31 @@
+from django.contrib.admin import SimpleListFilter
+from django.contrib.contenttypes.models import ContentType
+from .models import SearchkitSearch
+from .forms import SearchkitFormSet
+from .forms.utils import get_filter_rules
+
+
+class SearchkitFilter(SimpleListFilter):
+    title = 'Searchkit Filter'
+    parameter_name = 'search'
+    template = 'searchkit/searchkit_filter.html'
+
+    def __init__(self, request, params, model, model_admin):
+        # We need the app_label and model_name for the reverse url lookup in the
+        # template.
+        self.app_label = model._meta.app_label
+        self.model_name = model._meta.model_name
+        super().__init__(request, params, model, model_admin)
+
+    def lookups(self, request, model_admin):
+        # Fetch the last three objects from SearchkitSearch and return them as
+        # choices.
+        ct = ContentType.objects.get_for_model(model_admin.model)
+        searches = SearchkitSearch.objects.filter(contenttype=ct).order_by('-created_date')[:3]
+        return [(str(obj.id), obj.name) for obj in searches]
+
+    def queryset(self, request, queryset):
+        # Filter the queryset based on the selected SearchkitSearch object
+        if self.value():
+            search = SearchkitSearch.objects.get(id=int(self.value()))
+            return queryset.filter(**search.get_filter_rules())

build/lib/searchkit/forms/__init__.py

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

build/lib/searchkit/forms/fields.py

@@ -0,0 +1,55 @@
+from django import forms
+from django.utils.translation import gettext_lazy as _
+
+
+class RangeWidget(forms.MultiWidget):
+    def decompress(self, value):
+        """The value should be already a list."""
+        if value:
+            return value
+        else:
+            return [None, None]
+
+
+class BaseRangeField(forms.MultiValueField):
+    incomplete_message = None
+    field_type = None
+    widget_type = None
+    field_kwargs = dict()
+
+    def __init__(self, **kwargs):
+        error_messages = dict(incomplete=self.incomplete_message)
+        widget = RangeWidget(widgets=[self.widget_type, self.widget_type])
+        fields = (
+            self.field_type(label=_('From'), **self.field_kwargs),
+            self.field_type(label=_('To'), **self.field_kwargs),
+        )
+        super().__init__(
+            fields=fields,
+            widget=widget,
+            error_messages=error_messages,
+            require_all_fields=True,
+            **kwargs
+        )
+
+    def compress(self, data_list):
+        """We want the data list as data list."""
+        return data_list
+
+
+class IntegerRangeField(BaseRangeField):
+    incomplete_message = _("Enter the first and the last number.")
+    field_type = forms.IntegerField
+    widget_type = forms.NumberInput
+
+
+class DateRangeField(BaseRangeField):
+    incomplete_message = _("Enter the first and the last date.")
+    field_type = forms.DateField
+    widget_type = forms.DateInput
+
+
+class DateTimeRangeField(BaseRangeField):
+    incomplete_message = _("Enter the first and the last datetime.")
+    field_type = forms.DateTimeField
+    widget_type = forms.DateTimeInput

build/lib/searchkit/forms/search.py

@@ -0,0 +1,42 @@
+from django import forms
+from django.utils.functional import cached_property
+from ..models import SearchkitSearch
+from .searchkit import SearchkitFormSet
+
+
+class SearchkitSearchForm(forms.ModelForm):
+    """
+    Represents a SearchkitSearch model. Using a SearchkitFormSet for the data
+    json field.
+    """
+    class Meta:
+        model = SearchkitSearch
+        fields = ['name']
+
+    @property
+    def media(self):
+        # TODO: Check if child classes inherit those media files.
+        return self.formset.media
+
+    @cached_property
+    def formset(self):
+        """
+        A searchkit formset for the model.
+        """
+        kwargs = dict()
+        kwargs['data'] = self.data or None
+        kwargs['prefix'] = self.prefix
+        if self.instance.pk:
+            kwargs['model'] = self.instance.contenttype.model_class()
+            kwargs['initial'] = self.instance.data
+        return SearchkitFormSet(**kwargs)
+
+    def is_valid(self):
+        return self.formset.is_valid() and super().is_valid()
+
+    def clean(self):
+        if self.formset.contenttype_form.is_valid():
+            self.instance.contenttype = self.formset.contenttype_form.cleaned_data['contenttype']
+        if self.formset.is_valid():
+            self.instance.data = self.formset.cleaned_data
+        return super().clean()