🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

drf-querystringfilter

Package Overview
Dependencies
Maintainers
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

drf-querystringfilter

Filter backend for DjangoRestFramework able to parse url parameters

1.0.0
PyPI
Maintainers
2

===================== drf-querystringfilter

.. image:: https://badge.fury.io/py/drf-querystringfilter.png :target: https://badge.fury.io/py/drf-querystringfilter

Filter backend for DjangoRestFramework able to parse url parameters

Supports drf 3.5.x, 3.6.x, 3.7.x, 3.8.x Django 1.10.x, 1.11.x, 2.0.x, python 2.7, 3.6

Documentation

The full documentation is at https://drf-querystringfilter.readthedocs.org.

Basic Usage

.. code-block:: python

class UserSerializer(ModelSerializer):
    class Meta:
        model = User
        exclude = ()


class Users(ListAPIView):
    serializer_class = UserSerializer
    filter_fields = ['username', 'email', 'is_staff', 'date_joined']
    filter_blacklist = None
    filter_backends = (QueryStringFilterBackend,)
    queryset = User.objects.all()

now you can query using...

.. code-block:: sh

- /users/?username=sax
- /users/?username__startswith=sa&date_joined__year=2000
- /users/?email__contains=@gmail.com
- /users/?is_staff=true

Links


+--------------------+----------------+--------------+---------------------------+
| Stable             | |master-build| | |master-cov| |  |master-doc|             |
+--------------------+----------------+--------------+---------------------------+
| Development        | |dev-build|    | |dev-cov|    |  |dev-doc|                |
+--------------------+----------------+--------------+---------------------------+
| Project home page: |https://github.com/saxix/drf-querystringfilter             |
+--------------------+---------------+-------------------------------------------+
| Issue tracker:     |https://github.com/saxix/drf-querystringfilter/issues?sort |
+--------------------+---------------+-------------------------------------------+
| Download:          |http://pypi.python.org/pypi/drf-querystringfilter/         |
+--------------------+---------------+-------------------------------------------+
| Documentation:     |https://drf-querystringfilter.readthedocs.org/en/latest/   |
+--------------------+---------------+--------------+----------------------------+


.. |master-build| image:: https://secure.travis-ci.org/saxix/drf-querystringfilter.png?branch=master
                    :target: http://travis-ci.org/saxix/drf-querystringfilter/

.. |master-cov| image:: https://codecov.io/gh/saxix/drf-querystringfilter/branch/master/graph/badge.svg
                    :target: https://codecov.io/gh/saxix/drf-querystringfilter

.. |master-doc| image:: https://readthedocs.org/projects/drf-querystringfilter/badge/?version=stable
                    :target: http://drf-querystringfilter.readthedocs.io/en/stable/

.. |dev-build| image:: https://secure.travis-ci.org/saxix/drf-querystringfilter.png?branch=develop
                  :target: http://travis-ci.org/saxix/drf-querystringfilter/

.. |dev-cov| image:: https://codecov.io/gh/saxix/drf-querystringfilter/branch/develop/graph/badge.svg
                    :target: https://codecov.io/gh/saxix/drf-querystringfilter

.. |dev-doc| image:: https://readthedocs.org/projects/drf-querystringfilter/badge/?version=latest
                :target: http://drf-querystringfilter.readthedocs.io/en/latest/


1.0
===
* First stable release

0.7.0
=====
* abstract query_params habdling
* handle multple values in query string
* BACKWARD INCOMPATIBLE: `__in` now accept raw values and can appear multiple times
* new operators `__inlist` and `__not_inlist` to be used for backward compatibility with `__in` and `__not_in`


0.6.0
=====
* Add handling of format query param


0.5.0 18/06/2018
================
* add support for django 2.0
* add `query_params` property to allow handling POST request


0.4.0 29/05/2017
================
* add '__inarray' and  '__int_inarray' lookup to handle json/arrays lookup both str/int


0.3.0 10/10/16
==============
* add '_distinct' parameter to enable '.distinct()' queries


0.2.0 19/09/16
==============
* add 'ignore_filter' to ignore querystring arguments


0.1.0 11/09/16
==============
* First release on PyPI.

Keywords

drf-querystringfilter

FAQs

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts