Really simple django-app for search by Q-expressions
Project description
# django-silly-search
Simple django-app for search by Q-expressions.
If you need the simple way to search, without full-text,
morphology features, this app may be useful. But, if you need search for more
complicated case, you should use something like [Haystack](http://haystacksearch.org/)
## Features
* Search for one or few models
* Search for multiple fields
## Install
Clone this repo and install from the source:
```
git clone https://github.com/Egregors/django-silly-search.git
cd django-silly-search
pip install -e .
```
or just use PyPI
```
pip install django-silly-search
```
## How to use
The app provides a single function:
```
from silly_search import q_search
# q_search(models, fields, q) -> QuerySet
```
The functions takes required arguments:
`models` – Models for search. Should be instance of `ModelBase` (regular Model)
or `list` of `ModelBase` instances
`fields` – Fields for search. Should be `str` or `list` of `str` (just name of models field)
`q` – phrase for search. Should be an `str`
## Example
Let's say you have Models:
```
class Article(models.Model):
title = models.CharField(max_length=128)
description = models.CharField(max_length=255)
text = models.TextField()
class News(models.Model):
pub_date = models.DateTimeField(auto_now_add=True)
title = models.CharField(max_length=128)
text = models.TextField()Z
```
and you want to make search on these models. So, you can search for one model and one field:
```
q_search(Article, 'title', q='spam')
```
or for one models, but few fields:
```
q_search(Article, fields=['title', 'text'], q='spam')
```
or for few models and few fields:
```
q_search(models=[Article, News], fields=['title', 'description', 'text'], q='spam')
```
## Contributing
Bug reports, bug fixes, and new features are always welcome.
Please open issues, and submit pull requests for any new code.
Simple django-app for search by Q-expressions.
If you need the simple way to search, without full-text,
morphology features, this app may be useful. But, if you need search for more
complicated case, you should use something like [Haystack](http://haystacksearch.org/)
## Features
* Search for one or few models
* Search for multiple fields
## Install
Clone this repo and install from the source:
```
git clone https://github.com/Egregors/django-silly-search.git
cd django-silly-search
pip install -e .
```
or just use PyPI
```
pip install django-silly-search
```
## How to use
The app provides a single function:
```
from silly_search import q_search
# q_search(models, fields, q) -> QuerySet
```
The functions takes required arguments:
`models` – Models for search. Should be instance of `ModelBase` (regular Model)
or `list` of `ModelBase` instances
`fields` – Fields for search. Should be `str` or `list` of `str` (just name of models field)
`q` – phrase for search. Should be an `str`
## Example
Let's say you have Models:
```
class Article(models.Model):
title = models.CharField(max_length=128)
description = models.CharField(max_length=255)
text = models.TextField()
class News(models.Model):
pub_date = models.DateTimeField(auto_now_add=True)
title = models.CharField(max_length=128)
text = models.TextField()Z
```
and you want to make search on these models. So, you can search for one model and one field:
```
q_search(Article, 'title', q='spam')
```
or for one models, but few fields:
```
q_search(Article, fields=['title', 'text'], q='spam')
```
or for few models and few fields:
```
q_search(models=[Article, News], fields=['title', 'description', 'text'], q='spam')
```
## Contributing
Bug reports, bug fixes, and new features are always welcome.
Please open issues, and submit pull requests for any new code.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for django-silly-search-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7063b0ab1766b239a07f98353b497fdc8e3f651fc44ac71acd4d6335125fe7a4 |
|
MD5 | dfa32f2381bf64ce0aa4e27f91f6c337 |
|
BLAKE2b-256 | fca156c06f5797506068a70703e258e76bd67785771e8a42961726228aac1aa5 |
Close
Hashes for django_silly_search-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ce50aa74c4fc3a0979145e3fe700463578ae75224c0e3af2cc6c7c0235e8bda |
|
MD5 | ae7b151477a2f50cf997a515f6b27efa |
|
BLAKE2b-256 | fa34a6a51a9ee4b17e0fbd681f7f1fe236bcf4cc7202593821f44e44f7256853 |