Mimicking the Django ORM queryset over rest framework api
Project description
[![Build Status](https://travis-ci.org/variable/django-rest-framework-queryset.svg?branch=master)](https://travis-ci.org/variable/django-rest-framework-queryset.svg?branch=master)
# Django Rest Framework QuerySet
Mimicking the Django ORM queryset over rest framework api
## Usage:
### normal operation
```python
from rest_framework_queryset import RestFrameworkQuerySet
from django.core.paginator import Paginator
qs = RestFrameworkQuerySet('http://localhost:8082/api/')
qs.all()
# filter
boys = qs.filter(gender='boy')
girls = qs.filter(gender='girls')
# slicing
first_100_boys = boys[:100]
# pagination
p = Paginator(qs, 10)
print p.count
print p.num_pages
page1 = p.page(1)
```
### class based view
```python
from django.views.generic import ListView
from rest_framework_queryset import RestFrameworkQuerySet
class ListDataView(ListView):
paginate_by = 10
template_name = 'list.html'
def get_queryset(self, *args, **kwargs):
return RestFrameworkQuerySet('http://localhost:8082/api/').filter(**self.request.GET.dict())
```
## Dependencies
The queryset is dependent on the API that uses [LimiteOffsetPagination](http://www.django-rest-framework.org/api-guide/pagination/#limitoffsetpagination)
If you are using [PageNumberPagination](http://www.django-rest-framework.org/api-guide/pagination/#pagenumberpagination) then you can use the included `rest_framework_queryset.pagination.HybridPagination` which will switch pagination class depends on the query param is passed.
# Django Rest Framework QuerySet
Mimicking the Django ORM queryset over rest framework api
## Usage:
### normal operation
```python
from rest_framework_queryset import RestFrameworkQuerySet
from django.core.paginator import Paginator
qs = RestFrameworkQuerySet('http://localhost:8082/api/')
qs.all()
# filter
boys = qs.filter(gender='boy')
girls = qs.filter(gender='girls')
# slicing
first_100_boys = boys[:100]
# pagination
p = Paginator(qs, 10)
print p.count
print p.num_pages
page1 = p.page(1)
```
### class based view
```python
from django.views.generic import ListView
from rest_framework_queryset import RestFrameworkQuerySet
class ListDataView(ListView):
paginate_by = 10
template_name = 'list.html'
def get_queryset(self, *args, **kwargs):
return RestFrameworkQuerySet('http://localhost:8082/api/').filter(**self.request.GET.dict())
```
## Dependencies
The queryset is dependent on the API that uses [LimiteOffsetPagination](http://www.django-rest-framework.org/api-guide/pagination/#limitoffsetpagination)
If you are using [PageNumberPagination](http://www.django-rest-framework.org/api-guide/pagination/#pagenumberpagination) then you can use the included `rest_framework_queryset.pagination.HybridPagination` which will switch pagination class depends on the query param is passed.
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
Close
Hashes for django-rest-framework-queryset-0.0.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef66d9c5a0422dd2c29f34b39ef32d7be8364eaaa83589d4fb49f9fb1c0ab29f |
|
MD5 | c10f895ba713ea3c41b1663ce56556d1 |
|
BLAKE2b-256 | 2f904404ab552fca093e4d73f9b840c86a40cdf6885571ec9a837d5720de2542 |