FilterMapBackend is FilterBackend like DjangoFilterBackend
Currently, drf-filtermapbackend is not released to PYPI.
So you can only install
it directly from github by running
pip install git+https://github.com/aayulogic/filtermapbackend@master
- Clone the repo
git clone https://github.com/aayulogic/filtermapbackend
cd filtermapbackend
- Install requirements
pip install -r requirementst.txt
- Install using
setup.py
python setup.py install
Example Usage
from rest_framework.viewsets import ModelViewSet
from filter_map.backends import FilterMapBackend
class ProfileViewSet(ModelViewSet):
"""
Consider Profile Model has user FK,
"""
queryset = ...
serializer_class = ...
filter_backends = (FilterMapBackend,)
filter_map = {
# plain map
'first_name': 'user__first_name',
# used with lte operator
'joined_before': 'date_joined__date__lte',
# also supports separate field name and operator
'last_name': ('user__last_name', 'iexact'),
}
- Add test cases for FilterMapBackend
- Update Readme