Metadata-Version: 2.1
Name: django-mongoengine-filter
Version: 0.1
Summary: django-mongoengine-filter is a reusable Django application inspired from django-filter for allowing mongoengine users to filter querysets dynamically.
Home-page: https://github.com/barseghyanartur/django-mongoengine-filter
Author: Artur Barseghyhan
Author-email: artur.barseghyan@gmail.com
License: BSD
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Framework :: Django

Django Filter MonogoEngine
===========================

django-mongoengine-filter is a reusable Django application for allowing users
to filter `mongoengine querysets`_ dynamically.

Full documentation on `read the docs`_.

.. image:: https://img.shields.io/pypi/v/django-mongoengine-filter.svg
   :target: https://pypi.python.org/pypi/django-mongoengine-filter
   :alt: PyPI Version

Requirements
------------

* Python 3.5+
* Django 2.1+

Installation
------------

Install using pip:

.. code-block:: sh

    pip install django-mongoengine-filter

Or from repository directly:

.. code-block:: sh

    pip install https://github.com/barseghyanartur/django-mongoengine-filter/archive/master.zip

Usage
-----

.. code-block:: python

    import django_filters_mongoengine

    class ProductFilter(django_filters_mongoengine.FilterSet):
        class Meta:
            model = Product
            fields = ['name', 'price', 'manufacturer']

And then in your view you could do:

.. code-block:: python

    def product_list(request):
        filter = ProductFilter(request.GET, queryset=Product.objects.all())
        return render_to_response('my_app/template.html', {'filter': filter})

.. _`mongoengine querysets`: http://mongoengine-odm.readthedocs.org/apireference.html#module-mongoengine.queryset
.. _`read the docs`: https://django-filter.readthedocs.org/en/latest/


