Metadata-Version: 1.1
Name: django-filternaut
Version: 0.0.1
Summary: Filternaut constructs arbitrarily nested Q objects from flat data, such as query parameters.
Home-page: http://github.com/bennullgraham/django-filternaut/
Author: Ben Graham
Author-email: bgraham@bgraham.com.au
License: BSD
Description: Filternaut
        **********
        
        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 can
        lead to unexpected join behaviour. Filternaut does not suffer this problem, and
        can better model the relationships between filters.
        
        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 2.7 and 3.4
        - Django 1.2 through to 1.8 alpha 1
        - Django REST Framework 2.4 and 3.0 (optional)
        
        Documentation
        =============
        
        See http://filternaut.readthedocs.org/en/latest/ for full documentation.
        
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
