Metadata-Version: 2.0
Name: django-filternaut
Version: 0.0.13
Summary: Construct arbitrarily complex Django "Q" filters from flat data, such as query parameters.
Home-page: https://github.com/bennullgraham/filternaut
Author: Ben Graham
Author-email: bgraham@bgraham.com.au
License: BSD
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Utilities
Classifier: Framework :: Django
Requires-Dist: six (>=1.9.0)

Filternaut
**********

.. image:: https://travis-ci.org/bennullgraham/filternaut.svg?branch=master
   :target: https://travis-ci.org/bennullgraham/filternaut
.. image:: https://landscape.io/github/bennullgraham/filternaut/master/landscape.svg?style=flat
   :target: https://landscape.io/github/bennullgraham/filternaut/master
   :alt: Code Health

Filternaut is a simple library which generates arbitrarily complex Django
Q-objects from simple data. It fits nicely into situations where users provide
data which you want to filter a queryset with.

Filternaut is indirectly a collection of fields, but it differs from Django
forms in that you specify the logical relationships between fields, as well
their names and types.

Filternaut is similar to Django Filters, but does not provide any machinery for
rendering a user interface and does not inspect your models to autogenerate
filters. However, Django Filters chains many calls to ``.filter()`` which means
OR-like behaviour with more than one join. Filternaut supports either
behaviour.

Quickstart
==========

.. code-block:: python

    # filters are combined using logical operators
    filters = (
        DateTimeFilter('created_date', lookups=['lt', 'gt']) &
        CharFilter('username', lookups=['icontains']))

    # they can read their values from anything dict-like
    filters.parse(request.GET)

    # and have a form-like 'validity pattern'.
    if filters.valid:
        queryset = queryset.filter(filters.Q)
    else:
        raise HttpResponseBadRequest(json.dumps(filters.errors))


Installation
============

.. code-block:: console

    $ pip install django-filternaut

Filternaut is compatible with:

- Python 3
- Django 2.2 and 3.0
- Django REST Framework 3.11 (optional)

Python 2.7 support is still in the codebase but no longer tested. You are
welcome to try your luck.

Documentation
=============

See https://filternaut.readthedocs.org for full documentation.


