Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/barseghyanartur/django-mongoengine-filter
django-filter for MongoEngine
https://github.com/barseghyanartur/django-mongoengine-filter
django django-filter mongoengine
Last synced: 20 days ago
JSON representation
django-filter for MongoEngine
- Host: GitHub
- URL: https://github.com/barseghyanartur/django-mongoengine-filter
- Owner: barseghyanartur
- Created: 2019-03-25T13:23:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-12T10:14:43.000Z (4 months ago)
- Last Synced: 2024-10-13T07:45:56.785Z (about 1 month ago)
- Topics: django, django-filter, mongoengine
- Language: Python
- Homepage: https://pypi.org/project/django-mongoengine-filter/
- Size: 126 KB
- Stars: 13
- Watchers: 4
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE_GPL2.0.txt
Awesome Lists containing this project
README
=========================
django-mongoengine-filter
=========================
``django-mongoengine-filter`` is a reusable Django application for allowing
users to filter `mongoengine querysets`_ dynamically. It's very similar to
popular ``django-filter`` library and is designed to be used as a drop-in
replacement (as much as it's possible) strictly tied to ``MongoEngine``.
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
.. image:: https://img.shields.io/pypi/pyversions/django-mongoengine-filter.svg
:target: https://pypi.python.org/pypi/django-mongoengine-filter/
:alt: Supported Python versions
.. image:: https://github.com/barseghyanartur/django-mongoengine-filter/workflows/test/badge.svg
:target: https://github.com/barseghyanartur/django-mongoengine-filter/actions
:alt: Build Status
.. image:: https://readthedocs.org/projects/django-mongoengine-filter/badge/?version=latest
:target: http://django-mongoengine-filter.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/license-GPL--2.0--only%20OR%20LGPL--2.1--or--later-blue.svg
:target: https://github.com/barseghyanartur/django-mongoengine-filter/#License
:alt: GPL-2.0-only OR LGPL-2.1-or-later
.. image:: https://coveralls.io/repos/github/barseghyanartur/django-mongoengine-filter/badge.svg?branch=master
:target: https://coveralls.io/github/barseghyanartur/django-mongoengine-filter?branch=master
:alt: Coverage
Requirements
============
* Python 3.7, 3.8, 3.9, 3.10 or 3.11.
* MongoDB 3.x, 4.x, 5.x.
* Django 2.2, 3.0, 3.1, 3.2, 4.0 or 4.1.
Installation
============
Install using pip:
.. code-block:: sh
pip install django-mongoengine-filter
Or latest development version:
.. code-block:: sh
pip install https://github.com/barseghyanartur/django-mongoengine-filter/archive/master.zip
Usage
=====
**Sample document**
.. code-block:: python
from mongoengine import fields, document
from .constants import PROFILE_TYPES, PROFILE_TYPE_FREE, GENDERS, GENDER_MALE
class Person(document.Document):
name = fields.StringField(
required=True,
max_length=255,
default="Robot",
verbose_name="Name"
)
age = fields.IntField(required=True, verbose_name="Age")
num_fingers = fields.IntField(
required=False,
verbose_name="Number of fingers"
)
profile_type = fields.StringField(
required=False,
blank=False,
null=False,
choices=PROFILE_TYPES,
default=PROFILE_TYPE_FREE,
)
gender = fields.StringField(
required=False,
blank=False,
null=False,
choices=GENDERS,
default=GENDER_MALE
)
def __str__(self):
return self.name
**Sample filter**
.. code-block:: python
import django_mongoengine_filter
class PersonFilter(django_mongoengine_filter.FilterSet):
profile_type = django_mongoengine_filter.StringFilter()
ten_fingers = django_mongoengine_filter.MethodFilter(
action="ten_fingers_filter"
)
class Meta:
model = Person
fields = ["profile_type", "ten_fingers"]
def ten_fingers_filter(self, queryset, name, value):
if value == 'yes':
return queryset.filter(num_fingers=10)
return queryset
**Sample view**
With function-based views:
.. code-block:: python
def person_list(request):
filter = PersonFilter(request.GET, queryset=Person.objects)
return render(request, "dfm_app/person_list.html", {"object_list": filter.qs})
Or class-based views:
.. code-block:: python
from django_mongoengine_filter.views import FilterView
class PersonListView(FilterView):
filterset_class = PersonFilter
template_name = "dfm_app/person_list.html"
**Sample template**
.. code-block:: html
- {{ obj.name }} - {{ obj.age }}
{% for obj in object_list %}
{% endfor %}
**Sample requests**
- GET /persons/
- GET /persons/?profile_type=free&gender=male
- GET /persons/?profile_type=free&gender=female
- GET /persons/?profile_type=member&gender=female
- GET /persons/?ten_fingers=yes
Development
===========
Testing
-------
To run tests in your working environment type:
.. code-block:: sh
pytest -vrx
To test with all supported Python versions type:
.. code-block:: sh
tox
Running MongoDB
---------------
The easiest way is to run it via Docker:
.. code-block:: sh
docker pull mongo:latest
docker run -p 27017:27017 mongo:latest
Writing documentation
---------------------
Keep the following hierarchy.
.. code-block:: text
=====
title
=====
header
======
sub-header
----------
sub-sub-header
~~~~~~~~~~~~~~
sub-sub-sub-header
^^^^^^^^^^^^^^^^^^
sub-sub-sub-sub-header
++++++++++++++++++++++
sub-sub-sub-sub-sub-header
**************************
License
=======
GPL-2.0-only OR LGPL-2.1-or-later
Support
=======
For any security issues contact me at the e-mail given in the `Author`_ section.
For overall issues, go to `GitHub `_.
Author
======
Artur Barseghyan
.. _`mongoengine querysets`: http://mongoengine-odm.readthedocs.org/apireference.html#module-mongoengine.queryset
.. _`read the docs`: https://django-mongoengine-filter.readthedocs.org/