Metadata-Version: 2.4
Name: tinykw
Version: 1.0.10
Summary: Python binding for TinyKW
Project-URL: Homepage, https://voyelle.io/tinykw
Project-URL: Repository, https://github.com/voyelle-io/tinykw.git
Keywords: keyword spotting,wake word
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: numpy; extra == "dev"
Requires-Dist: scipy; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Dynamic: license-file

# Python binding for TinyKW

## Installation

```
pip install tinykw
```

## Usage

```python
from tinykw import TkwEngine

engine = TkwEngine(language="es")

kw_id = engine.add_keyword(data=kw_bytes, detection_threshold=0.5)
# ... 
engine.process_frame(samples)
# ...
if engine.is_keyword_detected(kw_id):
    engine.clear_keyword_flag(kw_id)
```

See [examples/python](https://github.com/voyelle-io/tinykw/tree/main/examples/python) for full usage.

## License

TinyKW is free for non-commercial use, including research, education, prototyping, and evaluation.
Please see [LICENSE](https://github.com/voyelle-io/tinykw/tree/main/LICENSE) for details. For commercial enquiries, please contact [contact@voyelle.io](mailto:contact@voyelle.io).
