Metadata-Version: 2.4
Name: tinykw
Version: 1.0.6
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
import tinykw

tinykw.tkw_init()

kw_id = tinykw.tkw_add_keyword(keyword_bytes, detection_threshold)
# ... 
tinykw.tkw_process_frame(samples)
# ...
if tinykw.tkw_is_keyword_detected(kw_id):
    tinykw.tkw_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).
