Metadata-Version: 2.4
Name: searchbox
Version: 0.1.0
Summary: A lightweight local corpus search package.
Author: searchbox
Keywords: search,retrieval,corpus,documents
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# searchbox

`searchbox` is a lightweight Python package for local document retrieval.

Current status:

- `corpussearch` is implemented.
- `websearch` and `docsearch` are reserved for future versions.

## Install

From this directory:

```bash
pip install .
```

If you later publish it to PyPI under the same package name, users can install it with:

```bash
pip install searchbox
```

## Quick start

```python
from searchbox import corpussearch

corpus = corpussearch(db_path="searchbox.db")

corpus.add_documents(
    [
        {"id": "doc-1", "content": "Searchbox is a lightweight local retrieval package."},
        {"id": "doc-2", "content": "Corpus search can index and retrieve text documents."},
    ]
)

ans = corpus.response("local retrieval")
print(ans)
```

