## Python package implementing search indices backed by Rust
### Installation
Install from PyPI (only built for Python 3.10+ on Linux)
```
pip install search-index
```
### Manual installation
Make sure you have 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
Q-gram index using either
- infix edit distance
- prefix edit distance
Prefix keyword index using either
- keyword occurrence
- keyword count
- tf-idf
- bm25
Similarity index using either
- brute force search
- inverted index search
- inverted index + HNSW search
All 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.10",
"maintainer_email": null,
"keywords": "utilities, index, q-gram, 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\nInstall from PyPI (only built for Python 3.10+ on Linux)\n\n```\npip install search-index\n```\n\n### Manual installation\n\nMake sure you have 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\nQ-gram index using either\n - infix edit distance\n - prefix edit distance\n\nPrefix keyword index using either\n - keyword occurrence\n - keyword count\n - tf-idf\n - bm25\n\nSimilarity index using either\n - brute force search\n - inverted index search\n - inverted index + HNSW search\n\nAll 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.1.0",
"project_urls": {
"Github": "https://github.com/bastiscode/search-index"
},
"split_keywords": [
"utilities",
" index",
" q-gram",
" prefix",
" similarity",
" search"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "902fd9ecbd36171426686fd37061df594efb24aafacdb2d5dad76c07180bc8cd",
"md5": "89eca3b5e969c0e287e46b1b1d4a9d09",
"sha256": "943d54ee801b5043a4cf08bbc84dcd300158b3ac6257368a815bd49d3dd22011"
},
"downloads": -1,
"filename": "search_index-0.1.0-cp310-abi3-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "89eca3b5e969c0e287e46b1b1d4a9d09",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.10",
"size": 587626,
"upload_time": "2024-11-23T14:23:02",
"upload_time_iso_8601": "2024-11-23T14:23:02.477485Z",
"url": "https://files.pythonhosted.org/packages/90/2f/d9ecbd36171426686fd37061df594efb24aafacdb2d5dad76c07180bc8cd/search_index-0.1.0-cp310-abi3-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-23 14:23:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bastiscode",
"github_project": "search-index",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "search-index"
}
JSON
