drf-addons-plus 0.4

This project provides some extra functionalities to be used with Django REST Framework

drf-addons-plus

Some magic to the base Django REST Framework

---

Overview

This project provides some extra functionalities to be used with Django REST Framework

• Field selection to Viewsets, eg. ?fields=id,name
• Conditional filtering to Viewsets, eg. ?conditional=active,-inactive
• Table hashing and 304 responses

You can also just copy the code manually and implement it yourself

---

Requirements

• Python 3.8+
• Django 4.2, 5.0, 5.1
• Django REST Framework 3.0+ or less, you can test it
• Celery 3.4 or less, you can test it

Installation

Install using pip...

pip install drf_addons_plus

---

Examples

• models.py:

from django.db import models

class FooModel(models.Model):
    name = models.CharField(max_length=100)
    status = models.BooleanField()
    category = models.CharField(choices=['foo', 'bar'])

• serializers.py:

from drf_addons_plus import serializers

from .models import FooModel


class FooSerializer(serializers.DynamicFieldsModelSerializer):
    class Meta:
        model = FooModel
        fields = ['name', 'status', 'category']

• views.py:

from rest_framework import filters
from drf_addons_plus import filters as filters_plus
from drf_addons_plus import viewsets

from .models import FooModel
from .serializers import FooSerializer


class FooViewSet(viewsets.FieldsModelViewSet):
    queryset = FooModel.objects.all()
    serializer_class = FooSerializer
    permission_classes = []
    filter_backends = [filters.SearchFilter, filters_plus.ConditionalFilter, filters_plus.FieldsFitlter]
    search_fields = ['name']
    conditional_fields = ['status']
    filter_fields = ['category']

• Request http://localhost:8000/foo/:

[
    {
        "name": "Bar",
        "status": false,
        "category": "Foo",
    }
]

• Request http://localhost:8000/foo/?fields=name&conditional=-status:

[
    {
        "name": "Bar"
    }
]

• Request http://localhost:8000/foo/?conditional=status:

[]

• Request http://localhost:8000/foo/?category="foo":

[
    {
        "name": "Bar",
        "status": false,
        "category": "Foo",
    }
]

Hashing for caching (WIP)

• views.py:

...
class FooViewSet(viewsets.HashesViewSet, viewsets.FieldsModelViewSet):
    ...
    hash_column = "name" # Default is `updated_at`
...

• Calculates hash on Create, Update or Delete
• Responses HEADER X-Data-Hash on Listing
• If HEADER X-Data-Hash passed on request, if matches current hash, returns 304, else list normally and returns new hash value
• Use this for caching your client / front-end (like ReactJS) / front-end server (Like NextJS with KeyDB redis)

---

Disclaimer

This project has started and maybe will be maintened, but it's simple enough to probably not give you any trouble. USE IT AT YOUR OWN RISK

Build

• Build

python setup.py sdist bdist_wheel

• Publish

twine upload dist/*

Credits

Django REST Framework YAtOff