Django package with useful utility classes
Project description
Django Utilitas
Django Utilitas is a library that contains many ready-to-use utility classes so that you can just focus on the business logic of your API.
Utilitas itself is built upon many other great Django packages such as drf-ff, drf-yasg and the Django REST Framework itself.
Feature summary
Here is a summarized version of Utilitas' features:
- pagination
- sorting
- filtering (searching)
- swagger API support
- nested read serializers
- limiting the response' field
- bulk creation of models
Installation
pip install django-utilitas
Documentation
Docs are still in progress. I have assignments to do :(
Setting up a simple CRUD endpoint
Utilitas provides BaseListView
, BaseDetails
and BaseSearchView
which are a more sophisticated version of DRF's default views.
With them, you can set up a powerful API with about 9 lines of codes.
# views.py
class AccountListView(BaseListView):
name = "Account list view" # optional
model = Account # subclass of BaseModel
serializer = AccountSerializer # subclass of BaseModelSerializer
class AccountDetailsView(BaseDetailsView):
name = "Account details view"
model = Account
serializer = AccountSerializer
class AccountSearchView(BaseSearchView):
name = "Account search view"
model = Account
serializer = AccountSerializer
Then, setup the urls like this. Please note that the argument must be named obj_id
.
#urls.py
urlpatterns = [
path("accounts/", views.AccountListView.as_view(), name="account-list"),
path("accounts/<int:obj_id>", views.AccountDetailsView.as_view(), name="account-details"),
path("accounts/search", views.AccountSearchView.as_view(), name="account-search"),
]
Then, when you go to your swagger endpoint, you should be able to see something like this:
Bulk Creation
When a POST request is made to list endpoints with the bulk
query parameter set to a truthy value, a ListSerializer
will be used to perform the creation process.
Request example
import requests
requests.post(
"api/books/?bulk=True",
{
# need to set this 'objects' parameter in the request body
"objects": [
{"title": "The Hobbit", "author": "J. R. R. Tolkein"},
{"title": "History of Burma", "author": "G. E. Harvey"}
]
}
)
Implementation
You can either inherit the Meta class from the BaseModelSerializer
class
class BookSerializer(BaseModelSerializer):
class Meta(BaseModelSerializer.Meta):
model = Book
fields = "__all__"
Or, set the list_serializer_class
option to utilitas.serializers.BaseListSerializer
. (more information here: https://www.django-rest-framework.org/api-guide/serializers/#listserializer)
from utilitas.serializers import BaseListSerializer
class BookSerializer(BaseModelSerializer):
class Meta:
model = Book
fields = "__all__"
list_serializer_class = BaseListSerializer
Changelog
-
1.2.7
- bug fixes
-
1.2.6
- bug fixes
-
1.2.5
- added
exclude_params
option in search endpoints.
- added
-
1.2.4
- fixed bug in pagination
-
1.2.3
- lowered required Python version
-
1.2.2
- increased character limit for
FilterParamSerializer
's fields.
- increased character limit for
-
1.2.1
- added a middleware for logging database queries in each request
- bug fixes
-
1.2.0
- added bulk creation
-
1.1.4
- bug fixes
-
1.1.3
- bug fixes
-
1.1.2 (the first usable version)
- bug fixes
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_utilitas-1.2.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38f31ecc53d8c0fd0b1559781a0b5b6fe6ea48ee7754f2d3b2a2743d5a08c289 |
|
MD5 | ab2d29d41df63a6c9b2beb02327ee9c7 |
|
BLAKE2b-256 | 2d7c270fe5921f618986ea89a08ddae4e15dae33b285e0f1813674e850fb279f |