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
collection = sifts.Collection(name="my_collection")
# Add docs to the index. Can also update and delete.
collection.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 = collection.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.8.2
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.8.2.tar.gz | 13.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sifts-0.8.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 21.7 kB
Release files / sifts-0.8.2.tar.gz
| Download URL | sifts-0.8.2.tar.gz |
|---|---|
| Size | 13.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
14e7924ec4dea35d0e5fc1933ccaf05923e936b5bd2909529d6dcf10f2f7141a
|
|
BLAKE2b-256 checksum How to use checksums |
198077c1bbd38940b02836d8f20093cab7bc88dc75693b607dace42d7df038e8
|
| 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.8.2-py3-none-any.whl
| Download URL | sifts-0.8.2-py3-none-any.whl |
|---|---|
| Size | 8.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
adc1ce7aecf1be3d6b39766b88a0e15291e2a770a1f052f49fd459898e31ae09
|
|
BLAKE2b-256 checksum How to use checksums |
a492a353d8cea3ec353cab8c00f0df2fd7006b25d12a64a0d6ec4df69b79c69c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.19
|
