semvec/pypi-packages huggingface dataset:
sonic-client 1.0.0
python client for sonic search backend
License: BSD 3-Clause License

# python-sonic-client

Python client for [sonic](https://github.com/valeriansaliou/sonic) search backend.

## Install

```
pip install sonic-client
```

## Examples

### Ingest 

```python
from sonic import IngestClient

with IngestClient("127.0.0.1", 1491, "password") as ingestcl:
    print(ingestcl.ping())
    print(ingestcl.protocol)
    print(ingestcl.bufsize)
    ingestcl.push("wiki", "articles", "article-1", "for the love of god hell")
    ingestcl.push("wiki", "articles", "article-2", "for the love of satan heaven")
    ingestcl.push("wiki", "articles", "article-3", "for the love of lorde hello")
    ingestcl.push("wiki", "articles", "article-4", "for the god of loaf helmet")
```


### Search

```python
from sonic import SearchClient

with SearchClient("127.0.0.1", 1491, "password") as querycl:
    print(querycl.ping())
    print(querycl.query("wiki", "articles", "for"))
    print(querycl.query("wiki", "articles", "love"))
    print(querycl.suggest("wiki", "articles", "hell"))
```


### Control

```python
from sonic import ControlClient

with ControlClient("127.0.0.1", 1491, "password") as controlcl:
    print(controlcl.ping())
    controlcl.trigger("consolidate")
```

## API reference

API documentation can be found at [docs/api](./docs/api) and also [Browsable](https://xmonader.github.io/python-sonic-client/api/sonic/)


## Difference from asonic

asonic uses asyncio and this client doesn't. It grew out of needing to use sonic within gevent context