Metadata-Version: 2.1
Name: hashedixsearch
Version: 1.0.3
Summary: in-process search-engine for python
Home-page: https://github.com/openculinary/hashedixsearch/
License: AGPL-3.0-or-later
Author: James Addison
Author-email: james@reciperadar.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: hashedindex (>=0.10.0,<0.11.0)
Project-URL: Repository, https://github.com/openculinary/hashedixsearch/
Description-Content-Type: text/markdown

# hashedixsearch

`hashedixsearch` is a lightweight in-process search engine for Python, with support for stemming, synonyms, custom token analyzers, and query match highlighting.

## Usage

```python
from hashedixsearch import HashedIXSearch

index = HashedIXSearch(synonyms={'search': 'find'})
index.add(
    doc_id=1,
    doc='find the needle in the haystack'
)

results = index.query_batch(['search'])
for query, hits in results:
    print(f'{query}: {hits}')
```

## Tests

To run the `hashedixsearch` test suite:

```bash
$ python -m unittest
```

This library uses [hashedindex](https://github.com/MichaelAquilina/hashedindex) for tokenization and indexing.

