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)
and operator
or operator
* 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.

Metadata

Release files for sifts 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sifts 0.7.0
File	Size	Uploaded
sifts-0.7.0.tar.gz	13.3 kB	Jul 24, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for sifts 0.7.0
File	Interpreter	ABI	Platform	Reset
sifts-0.7.0-py3-none-any.whl 7.8 kB Jul 24, 2024	Python 3	none	any	Details

Total release size: 21.1 kB

Release files / sifts-0.7.0.tar.gz

Download URL	sifts-0.7.0.tar.gz
Size	13.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`7a5f50ed6eccbfcd601466ec85c5b8ffe9d59b39af31955f4df506f0a551a8db`
BLAKE2b-256 checksum How to use checksums	`5eb8268d34b0c1bb50bf326fac2c6123c8642bc168276f56847f56cc299a5f3d`
Upload date	Jul 24, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.9.19`

Release files / sifts-0.7.0-py3-none-any.whl

Download URL	sifts-0.7.0-py3-none-any.whl
Size	7.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`3589132b0811a7bf23fa6f0e26751c22d293549514f4a5c3dbbc8dcee20283d7`
BLAKE2b-256 checksum How to use checksums	`ae5239762787a059ee9cad635ed5f1e82b04ce2eed92fc050353eed2cfacb19f`
Upload date	Jul 24, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.9.19`