Sifts – Simple Full Text Search
Sifts is a simple Python full text search engine library with an SQLite or PostgreSQL backend.
It is meant to be used with Python libraries that need full-text search support, but where deploying something like ElasticSearch is overkill.
It supports both SQLite FTS5 and PostgreSQL FTS as backends.
Installation
pip install sifts
Usage
import sifts
# by default, creates a new SQLite database in the working directory
search = sifts.SearchEngine()
# Add docs to the index. Can also update and delete.
search.add(
documents=["Lorem ipsum dolor", "sit amet"],
metadatas=[{"foo": "bar"}, {"foo": "baz"}], # otpional, can filter on these
ids=["doc1", "doc2"], # unique for each doc. Uses UUIDs if omitted
)
results = search.query(
"Lorem",
# limit=2, # optionally limit the number of results
# where={"foo": "bar"}, # optional filter
# order_by="foo", # sort by metadata key (rather than rank)
)
The API is inspired by chroma.
Search Syntax
Sifts supports the following search syntax:
- Search for individual words
- Search for multiple words (will match documents where all words are present)
andoperatororoperator*wildcard (in SQLite, supported anywhere in the search term, in PostgreSQL only at the end of the search term)
The search syntax is the same regardless of backend.
1 maintainer
Metadata
1 maintainer
Release files for sifts 0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sifts-0.3.tar.gz | 9.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sifts-0.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.3 kB
Release files / sifts-0.3.tar.gz
| Download URL | sifts-0.3.tar.gz |
|---|---|
| Size | 9.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
38eb21ec7e8300a1e579c045f1206192058fc9037485acbf764eb5cfa86c4202
|
|
BLAKE2b-256 checksum How to use checksums |
4367a76763bb87dc413c10cc3830d951e41dae235fb1c522a567902d22d82a6b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.19
|
Release files / sifts-0.3-py3-none-any.whl
| Download URL | sifts-0.3-py3-none-any.whl |
|---|---|
| Size | 6.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3a43692db20d86cf2a39c130fae35cca64db4434686f7b8885148570a7020bed
|
|
BLAKE2b-256 checksum How to use checksums |
f3673d2a5788031b80c09957326243fbb9b0d30a07fa5f76e7a1629297be5810
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.19
|
