# OpenVoiceOS STT HTTP Server
Turn any OVOS STT plugin into a micro service!
## Install
`pip install ovos-stt-http-server`
## Companion plugin
Use in your voice assistant with OpenVoiceOS [companion plugin](https://github.com/OpenVoiceOS/ovos-stt-server-plugin)
## Configuration
the plugin is configured just like if it was running in the assistant, under mycroft.conf
eg
```
"stt": {
"module": "ovos-stt-plugin-deepgram",
"ovos-stt-plugin-deepgram": {"key": "xtimes40"}
}
```
## Usage
```bash
ovos-stt-server --help
usage: ovos-stt-server [-h] [--engine ENGINE] [--port PORT] [--host HOST]
options:
-h, --help show this help message and exit
--engine ENGINE stt plugin to be used
--lang-engine LANG_ENGINE
audio language detection plugin to be used (optional)
--port PORT port number
--host HOST host
--lang LANG default language supported by plugin (default comes from mycroft.conf)
--multi Load a plugin instance per language (force lang support, loads multiple plugins into memory)
--gradio Enable Gradio Web UI
--cache Cache models for Gradio demo
--title TITLE Title for webUI
--description DESCRIPTION
Text description to print in UI
--info INFO Text to display at end of UI
--badge BADGE URL of visitor badge
```
> Note: `ffmpeg` is required for Gradio
eg `ovos-stt-server --engine ovos-stt-plugin-fasterwhisper --lang-engine ovos-audio-transformer-plugin-fasterwhisper`
## Docker
you can create easily create a docker file to serve any plugin
```dockerfile
FROM python:3.7
RUN pip3 install ovos-stt-http-server==0.0.1
RUN pip3 install {PLUGIN_HERE}
ENTRYPOINT ovos-stt-server --engine {PLUGIN_HERE}
```
build it
```bash
docker build . -t my_ovos_stt_plugin
```
run it
```bash
docker run -p 8080:9666 my_ovos_stt_plugin
```
Each plugin can provide its own Dockerfile in its repository using ovos-stt-http-server
Raw data
{
"_id": null,
"home_page": "https://github.com/OpenVoiceOS/ovos-stt-http-server",
"name": "ovos-stt-http-server",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "plugin STT OVOS OpenVoiceOS",
"author": "JarbasAi",
"author_email": "jarbasai@mailfence.com",
"download_url": "https://files.pythonhosted.org/packages/31/1a/a10f37e836769439569441abea75f61e75f7b5308b8d81a5a86891759ec5/ovos-stt-http-server-0.1.3.tar.gz",
"platform": null,
"description": "# OpenVoiceOS STT HTTP Server\n\nTurn any OVOS STT plugin into a micro service!\n\n## Install\n\n`pip install ovos-stt-http-server`\n\n## Companion plugin\n\nUse in your voice assistant with OpenVoiceOS [companion plugin](https://github.com/OpenVoiceOS/ovos-stt-server-plugin)\n\n## Configuration\n\nthe plugin is configured just like if it was running in the assistant, under mycroft.conf\n\neg\n```\n \"stt\": {\n \"module\": \"ovos-stt-plugin-deepgram\",\n \"ovos-stt-plugin-deepgram\": {\"key\": \"xtimes40\"}\n }\n```\n\n\n## Usage\n\n```bash\novos-stt-server --help\nusage: ovos-stt-server [-h] [--engine ENGINE] [--port PORT] [--host HOST]\n\noptions:\n -h, --help show this help message and exit\n --engine ENGINE stt plugin to be used\n --lang-engine LANG_ENGINE\n audio language detection plugin to be used (optional)\n --port PORT port number\n --host HOST host\n --lang LANG default language supported by plugin (default comes from mycroft.conf)\n --multi Load a plugin instance per language (force lang support, loads multiple plugins into memory)\n --gradio Enable Gradio Web UI\n --cache Cache models for Gradio demo\n --title TITLE Title for webUI\n --description DESCRIPTION\n Text description to print in UI\n --info INFO Text to display at end of UI\n --badge BADGE URL of visitor badge\n```\n> Note: `ffmpeg` is required for Gradio\n\neg `ovos-stt-server --engine ovos-stt-plugin-fasterwhisper --lang-engine ovos-audio-transformer-plugin-fasterwhisper`\n\n## Docker\n\nyou can create easily create a docker file to serve any plugin\n\n```dockerfile\nFROM python:3.7\n\nRUN pip3 install ovos-stt-http-server==0.0.1\n\nRUN pip3 install {PLUGIN_HERE}\n\nENTRYPOINT ovos-stt-server --engine {PLUGIN_HERE}\n```\n\nbuild it\n```bash\ndocker build . -t my_ovos_stt_plugin\n```\n\nrun it\n```bash\ndocker run -p 8080:9666 my_ovos_stt_plugin\n```\n\nEach plugin can provide its own Dockerfile in its repository using ovos-stt-http-server\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "simple aiohttp server to host OpenVoiceOS stt plugins as a service",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/OpenVoiceOS/ovos-stt-http-server"
},
"split_keywords": [
"plugin",
"stt",
"ovos",
"openvoiceos"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6d81cfe45c8b795fe3f8c552c827a91091eb27c95102d133c84f4bdcda294761",
"md5": "29952d42bde9f31595287b84c43c6a8f",
"sha256": "89946b3c89d1500c5fcc2014a11b2b95a84b2553a41c34ce9489b780e6aded84"
},
"downloads": -1,
"filename": "ovos_stt_http_server-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "29952d42bde9f31595287b84c43c6a8f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 523231,
"upload_time": "2025-01-16T00:58:43",
"upload_time_iso_8601": "2025-01-16T00:58:43.640397Z",
"url": "https://files.pythonhosted.org/packages/6d/81/cfe45c8b795fe3f8c552c827a91091eb27c95102d133c84f4bdcda294761/ovos_stt_http_server-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "311aa10f37e836769439569441abea75f61e75f7b5308b8d81a5a86891759ec5",
"md5": "6d810ceee914bd1dc098572921e4b916",
"sha256": "8300048ebecd6be7ca8af56f126ac48fd89b4fefe4c67bc9d98a0d477ec4b720"
},
"downloads": -1,
"filename": "ovos-stt-http-server-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "6d810ceee914bd1dc098572921e4b916",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 524098,
"upload_time": "2025-01-16T00:58:46",
"upload_time_iso_8601": "2025-01-16T00:58:46.363863Z",
"url": "https://files.pythonhosted.org/packages/31/1a/a10f37e836769439569441abea75f61e75f7b5308b8d81a5a86891759ec5/ovos-stt-http-server-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-16 00:58:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenVoiceOS",
"github_project": "ovos-stt-http-server",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ovos-stt-http-server"
}
JSON
