Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/knipknap/django-find
Easily add search/filter functionality to Django projects
https://github.com/knipknap/django-find
django json python query search
Last synced: about 2 months ago
JSON representation
Easily add search/filter functionality to Django projects
- Host: GitHub
- URL: https://github.com/knipknap/django-find
- Owner: knipknap
- License: mit
- Created: 2018-11-04T21:53:11.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-11T12:18:46.000Z (6 months ago)
- Last Synced: 2024-10-02T11:47:14.980Z (3 months ago)
- Topics: django, json, python, query, search
- Language: Python
- Homepage:
- Size: 152 KB
- Stars: 64
- Watchers: 5
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# django-find
[](https://travis-ci.org/knipknap/django-find)
[](https://coveralls.io/github/knipknap/django-find?branch=master)
[](https://lima.codeclimate.com/github/knipknap/django-find)
[](http://django-find.readthedocs.io/en/latest/?badge=latest)
## Summary
**django-find** is a Django app that makes it easy to add complex
search/filter functionality for the models in your project.
It supports two different ways to search your Django models:
Query-based, or JSON-based.
**django-find** is not a full text search engine, it searches the fields
of your models. In other words, it filters on your models and provides
tabular data as a result.
## Features
### Query-based search
By query-based, we mean that you can use statements like these
to search your models:
```
author:"robert frost" and (title:road or chapter:2)
```
### Add a search field to your template using a single tag
```
{% load find_tags %}
{% find object_list %}
{% for obj in object_list %}
{{ obj.name }}
{% endfor %}
```
(object\_list is a queryset that is passed to the template)
### Query in your code
Just add the Searchable mixin:
```python
from django_find import Searchable
class Author(models.Model, Searchable):
name = models.CharField("Author Name", max_length=10)
...
```
And you are good to go:
```python
# Query-based search returns a standard Django QuerySet that you
# can .filter() and work with as usual.
query = Book.by_query('author:"robert frost" and title:"the road"')
# You can also get a Django Q object for the statements.
q_obj = Book.q_from_query('author:"robert frost" and title:"the road"')
```
### Query using JSON
To make it easy to do complex searches spanning multiple models, JSON-based
query method is provided. It allows your to make custom searches like these:
For this, a JSON-based search functionality is provided:
```
{
"Author":{"name":[[["equals","test"]]]},
"Book": {"title":[[["notcontains","c"]]]},
"Chapter": {"content":[[["startswith","The "]]]}
}
```
django-find is smart in figuring out how to join those models
together and return a useful result.
In your code, you can load the JSON and get back the search
result:
```python
# JSON-based search exhausts what Django's ORM can do, so it does
# not return a Django QuerySet, but a row-based PaginatedRawQuerySet:
query, field_list = Book.by_json_raw('''{
"Chapter": {"title":[[["contains","foo"]]]}
}''')
print('|'.join(field_list))
for row in query:
print('|'.join(row))
```
## Documentation
Full documentation, including installation instructions, is here:
http://django-find.readthedocs.io