Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/miki725/django-url-filter

Django URL Filter provides a safe way to filter data via human-friendly URLs.
https://github.com/miki725/django-url-filter

django django-rest-framework filtering url-filter

Last synced: 6 days ago
JSON representation

Django URL Filter provides a safe way to filter data via human-friendly URLs.

Awesome Lists containing this project

README 

        
=================

Django URL Filter

=================



.. image:: https://badge.fury.io/py/django-url-filter.svg

   :target: http://badge.fury.io/py/django-url-filter

.. image:: https://readthedocs.org/projects/django-url-filter/badge/?version=latest

   :target: http://django-url-filter.readthedocs.io/en/latest/?badge=latest

.. image:: https://drone.miki725.com/api/badges/miki725/django-url-filter/status.svg

   :target: https://drone.miki725.com/miki725/django-url-filter

.. image:: https://codecov.io/gh/miki725/django-url-filter/branch/master/graph/badge.svg

   :target: https://codecov.io/gh/miki725/django-url-filter



Django URL Filter provides a safe way to filter data via human-friendly URLs.



* Free software: MIT license

* GitHub: https://github.com/miki725/django-url-filter

* Documentation: http://django-url-filter.readthedocs.io/



Overview

--------



The main goal of Django URL Filter is to provide an easy URL interface

for filtering data. It allows the user to safely filter by model

attributes and also allows to specify the lookup type for each filter

(very much like Django's filtering system in ORM).



For example the following will retrieve all items where the id is

``5`` and title contains ``"foo"``::



    example.com/listview/?id=5&title__contains=foo



In addition to basic lookup types, Django URL Filter allows to

use more sophisticated lookups such as ``in`` or ``year``.

For example::



    example.com/listview/?id__in=1,2,3&created__year=2013



Requirements

------------



* Python 2.7, 3.x, pypy or pypy3

* Django 1.8+ (there are plans to support older Django versions)

* Django REST Framework 2 or 3 (only if you want to use DRF integration)



Installing

----------



Easiest way to install this library is by using ``pip``::



    $ pip install django-url-filter



Usage Example

-------------



To make example short, it demonstrates Django URL Filter integration

with Django REST Framework but it can be used without DRF (see below).



::



  from url_filter.integrations.drf import DjangoFilterBackend



  class UserViewSet(ModelViewSet):

      queryset = User.objects.all()

      serializer_class = UserSerializer

      filter_backends = [DjangoFilterBackend]

      filter_fields = ['username', 'email']



Alternatively filterset can be manually created and used directly

to filter querysets::



  from django.http import QueryDict

  from url_filter.filtersets import ModelFilterSet



  class UserFilterSet(ModelFilterSet):

      class Meta(object):

          model = User



  query = QueryDict('email__contains=gmail&joined__gt=2015-01-01')

  fs = UserFilterSet(data=query, queryset=User.objects.all())

  filtered_users = fs.filter()



Above will automatically allow the use of all of the Django URL Filter features.

Some possibilities::



    # get user with id 5

    example.com/users/?id=5



    # get user with id either 5, 10 or 15

    example.com/users/?id__in=5,10,15



    # get user with id between 5 and 10

    example.com/users/?id__range=5,10



    # get user with username "foo"

    example.com/users/?username=foo



    # get user with username containing case insensitive "foo"

    example.com/users/?username__icontains=foo



    # get user where username does NOT contain "foo"

    example.com/users/?username__icontains!=foo



    # get user who joined in 2015 as per user profile

    example.com/users/?profile__joined__year=2015



    # get user who joined in between 2010 and 2015 as per user profile

    example.com/users/?profile__joined__range=2010-01-01,2015-12-31



    # get user who joined in after 2010 as per user profile

    example.com/users/?profile__joined__gt=2010-01-01



Features

--------



* **Human-friendly URLs**



  Filter querystring format looks

  very similar to syntax for filtering in Django ORM.

  Even negated filters are supported! Some examples::



    example.com/users/?email__contains=gmail&joined__gt=2015-01-01

    example.com/users/?email__contains!=gmail  # note !



* **Related models**



  Support related fields so that filtering can be applied to related

  models. For example::



    example.com/users/?profile__nickname=foo



* **Decoupled filtering**



  How URLs are parsed and how data is filtered is decoupled.

  This allows the actual filtering logic to be decoupled from Django

  hence filtering is possible not only with Django ORM QuerySet but

  any set of data can be filtered (e.g. SQLAlchemy query objects)

  assuming corresponding filtering backend is implemented.



* **Usage-agnostic**



  This library decouples filtering from any particular usage-pattern.

  It implements all the basic building blocks for creating

  filtersets but it does not assume how they will be used.

  To make the library easy to use, it ships with some integrations

  with common usage patterns like integration with Django REST Framework.

  This means that its easy to use in custom applications with custom

  requirements (which is probably most of the time!)