# Python package implementing search indices backed by Rust
## Installation
Make sure you have
[Faiss](https://github.com/facebookresearch/faiss/blob/main/INSTALL.md)
installed.
Install from PyPI (only built for Python 3.12+ on Linux)
```
pip install search-index
```
## Manual installation
Make sure you have Faiss and Rust installed, then do the following:
```bash
git clone https://github.com/bastiscode/search-index.git
cd search-index
pip install maturin[patchelf]
maturin develop --release
```
## Usage
See `build.py` and `query.py` for examples on how to build and query an index.
## Search indices
Prefix keyword index with one of the following score functions:
- keyword occurrence
Similarity index with one of the following index types:
- flat index (brute-force search)
- inverted index (bucket search)
- inverted index + HNSW
Both search indices also support searching only in a subset of the indexed records.
Raw data
{
"_id": null,
"home_page": null,
"name": "search-index",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "utilities, index, prefix, similarity, search",
"author": null,
"author_email": "Sebastian Walter <swalter@cs.uni-freiburg.de>",
"download_url": null,
"platform": null,
"description": "# Python package implementing search indices backed by Rust\n\n## Installation\n\nMake sure you have\n[Faiss](https://github.com/facebookresearch/faiss/blob/main/INSTALL.md)\ninstalled.\n\nInstall from PyPI (only built for Python 3.12+ on Linux)\n\n```\npip install search-index\n```\n\n## Manual installation\n\nMake sure you have Faiss and Rust installed, then do the following:\n\n```bash\ngit clone https://github.com/bastiscode/search-index.git\ncd search-index\npip install maturin[patchelf]\nmaturin develop --release\n```\n\n## Usage\n\nSee `build.py` and `query.py` for examples on how to build and query an index.\n\n## Search indices\n\nPrefix keyword index with one of the following score functions:\n\n- keyword occurrence\n\nSimilarity index with one of the following index types:\n\n- flat index (brute-force search)\n- inverted index (bucket search)\n- inverted index + HNSW\n\nBoth search indices also support searching only in a subset of the indexed records.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Search indices backed by Rust",
"version": "0.2.3",
"project_urls": {
"Github": "https://github.com/bastiscode/search-index"
},
"split_keywords": [
"utilities",
" index",
" prefix",
" similarity",
" search"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a51c015ccbbb38617b2bf735051aefca1e6f668455bf6d21eb042f540e15bfb8",
"md5": "41d0dc4283b74583f3beeac7f1fd31b2",
"sha256": "460ed3425a8391cf40cd2f3a52e25dbfa229aa17c43b9bb8d4aab4fd5f4a5f69"
},
"downloads": -1,
"filename": "search_index-0.2.3-cp312-abi3-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "41d0dc4283b74583f3beeac7f1fd31b2",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.12",
"size": 1265222,
"upload_time": "2025-08-04T11:30:17",
"upload_time_iso_8601": "2025-08-04T11:30:17.001611Z",
"url": "https://files.pythonhosted.org/packages/a5/1c/015ccbbb38617b2bf735051aefca1e6f668455bf6d21eb042f540e15bfb8/search_index-0.2.3-cp312-abi3-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-04 11:30:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bastiscode",
"github_project": "search-index",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "search-index"
}
JSON
