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.6.0
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.6.0.tar.gz | 12.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sifts-0.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 20.5 kB
Release files / sifts-0.6.0.tar.gz
| Download URL | sifts-0.6.0.tar.gz |
|---|---|
| Size | 12.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
03b2847dc447629282050d9057602bc024a6cf6c7098a1a4dc07674e12b75c3b
|
|
BLAKE2b-256 checksum How to use checksums |
ceaa1e87a7d97babaedfc6132add1a6ba2b7371464893e689a3f9eee672908e5
|
| 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.6.0-py3-none-any.whl
| Download URL | sifts-0.6.0-py3-none-any.whl |
|---|---|
| Size | 7.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0ab84d3ad74ad3c796cf5984433f1fd3c4b4ca07cfbaebee1c1dcdfa66e5fa14
|
|
BLAKE2b-256 checksum How to use checksums |
881f654c5cc75dee1c892b57cb61a11e5225d791c048766cfe558b98892aede6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.19
|
