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.5
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.5.tar.gz | 13.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sifts-0.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 20.5 kB
Release files / sifts-0.5.tar.gz
| Download URL | sifts-0.5.tar.gz |
|---|---|
| Size | 13.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
146ff3b651a38013833f344cfd1648f114773c170d489c3b0e52fa7d1cfc60c4
|
|
BLAKE2b-256 checksum How to use checksums |
5ca0834c3e61cbb65b478a4964c9ddb391326a51cff4b5d9f0a613b33f51870d
|
| 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.5-py3-none-any.whl
| Download URL | sifts-0.5-py3-none-any.whl |
|---|---|
| Size | 7.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8a5bef65cdb6f1b8ef426975aee09c36614249f0d5f5b13e7f4d4558ebbc77b4
|
|
BLAKE2b-256 checksum How to use checksums |
8e71361cc16553cc73cae7e7be3cac40915d5db19dfe170c4b7999d740ea4c83
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.19
|
