Metadata-Version: 2.1
Name: drf-lookup
Version: 0.1.2
Summary: Helper for retrieve select options of drf fields and django-filter filters.
Home-page: https://github.com/kindlycat/drf-lookup
License: MIT
Keywords: drf,django-filter
Author: Grigory Mishchenko
Author-email: grishkokot@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: django-filter (>=23.0,<24.0)
Requires-Dist: djangorestframework (>=3.14.0,<4.0.0)
Project-URL: Repository, https://github.com/kindlycat/drf-lookup
Description-Content-Type: text/markdown

# Drf-lookup

Drf-lookup helps you retrieve options for serializer fields and django-filter 
filters. It adds additional actions to the viewset, checks the `queryset` and 
`choices` attributes and returns valid values for the requested field/filter.

## Install

```bash
pip install drf-lookup
```

## Example

```python

# models
from django.db import models

class Category(models.Model):
    name = models.CharField(max_length=100, db_index=True)

    class Meta:
        verbose_name = 'category'
        verbose_name_plural = 'categories'
        ordering = ['name']

    def __str__(self) -> str:
        return self.name


class Article(models.Model):
    title = models.CharField(max_length=100, db_index=True)
    category = models.ForeignKey(Category, on_delete=models.CASCADE, null=True)

    class Meta:
        verbose_name = 'news'
        verbose_name_plural = 'news'
        ordering = ['-pk']

    def __str__(self) -> str:
        return self.title


# serializers
from rest_framework.serializers import ModelSerializer
class ArticleSerializer(ModelSerializer):
    class Meta:
        model = Article
        fields = ('id', 'title', 'category')


# filters
import django_filters
class ArticleFilterSet(django_filters.FilterSet):
    class Meta:
        model = Article
        fields = ('category',)


# views
from rest_framework.viewsets import ModelViewSet

from drf_lookup.views import LookupMixin


class ArticleViewSet(LookupMixin, ModelViewSet):
    queryset = Article.objects.all()
    serializer_class = ArticleSerializer
    filterset_class = ArticleFilterSet

```

Now, we can request options for the `category` field:

```
GET /articles/lookup_serializer/?lookup_action=create&lookup_field=category

GET /articles/lookup_filterset/?lookup_action=list&lookup_field=category
```

