# OpenVoiceOS TTS Server
Turn any OVOS TTS plugin into a micro service!
## Install
`pip install ovos-tts-server`
## Companion plugin
Use in your voice assistant with OpenVoiceOS [companion plugin](https://github.com/OpenVoiceOS/ovos-tts-server-plugin)
## Configuration
the plugin is configured just like if it was running in the assistant, under mycroft.conf
eg
```
"tts": {
"module": "ovos-tts-plugin-piper",
"ovos-tts-plugin-piper": {
"model": "alan-low"
}
}
```
## Usage
```bash
ovos-tts-server --help
usage: ovos-tts-server [-h] [--engine ENGINE] [--port PORT] [--host HOST] [--cache]
options:
-h, --help show this help message and exit
--engine ENGINE tts plugin to be used
--port PORT port number
--host HOST host
--cache save every synth to disk
```
eg, to use the [GladosTTS plugin](https://github.com/NeonGeckoCom/neon-tts-plugin-glados) `ovos-tts-server --engine neon-tts-plugin-glados --cache`
then do a get request `http://192.168.1.112:9666/synthesize/hello`
## Docker
you can create easily crete a docker file to serve any plugin
```dockerfile
FROM python:3.7
RUN pip3 install ovos-utils==0.0.15
RUN pip3 install ovos-plugin-manager==0.0.4
RUN pip3 install ovos-tts-server==0.0.1
RUN pip3 install {PLUGIN_HERE}
ENTRYPOINT ovos-tts-server --engine {PLUGIN_HERE} --cache
```
build it
```bash
docker build . -t my_ovos_tts_plugin
```
run it
```bash
docker run -p 8080:9666 my_ovos_tts_plugin
```
use it `http://localhost:8080/synthesize/hello`
Each plugin can provide its own Dockerfile in its repository using ovos-tts-server
Raw data
{
"_id": null,
"home_page": "https://github.com/OpenVoiceOS/ovos-tts-server",
"name": "ovos-tts-server",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "plugin TTS OVOS OpenVoiceOS",
"author": "JarbasAi",
"author_email": "jarbasai@mailfence.com",
"download_url": "https://files.pythonhosted.org/packages/c6/01/ca8b826bc9965d4be655e1affc535ae94ae42b16c6d28a7a252dda587f47/ovos-tts-server-0.1.3.tar.gz",
"platform": null,
"description": "# OpenVoiceOS TTS Server\n\nTurn any OVOS TTS plugin into a micro service!\n\n\n## Install\n\n`pip install ovos-tts-server`\n\n## Companion plugin\n\nUse in your voice assistant with OpenVoiceOS [companion plugin](https://github.com/OpenVoiceOS/ovos-tts-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 \"tts\": {\n \"module\": \"ovos-tts-plugin-piper\",\n \"ovos-tts-plugin-piper\": {\n \"model\": \"alan-low\"\n }\n }\n```\n\n## Usage\n\n```bash\novos-tts-server --help\nusage: ovos-tts-server [-h] [--engine ENGINE] [--port PORT] [--host HOST] [--cache]\n\noptions:\n -h, --help show this help message and exit\n --engine ENGINE tts plugin to be used\n --port PORT port number\n --host HOST host\n --cache save every synth to disk\n```\n\neg, to use the [GladosTTS plugin](https://github.com/NeonGeckoCom/neon-tts-plugin-glados) `ovos-tts-server --engine neon-tts-plugin-glados --cache`\n\nthen do a get request `http://192.168.1.112:9666/synthesize/hello`\n\n\n## Docker\n\nyou can create easily crete a docker file to serve any plugin\n\n```dockerfile\nFROM python:3.7\n\nRUN pip3 install ovos-utils==0.0.15\nRUN pip3 install ovos-plugin-manager==0.0.4\nRUN pip3 install ovos-tts-server==0.0.1\n\nRUN pip3 install {PLUGIN_HERE}\n\nENTRYPOINT ovos-tts-server --engine {PLUGIN_HERE} --cache\n```\n\nbuild it\n```bash\ndocker build . -t my_ovos_tts_plugin\n```\n\nrun it\n```bash\ndocker run -p 8080:9666 my_ovos_tts_plugin\n```\n\nuse it `http://localhost:8080/synthesize/hello`\n\nEach plugin can provide its own Dockerfile in its repository using ovos-tts-server\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "simple FastAPI server to host TTS plugins as a service",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/OpenVoiceOS/ovos-tts-server"
},
"split_keywords": [
"plugin",
"tts",
"ovos",
"openvoiceos"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2fa09c041f4bd8f48aa788a478e65f85b1ad960ca9cc2985b9a05256091ecabc",
"md5": "a4f86f76756721e19421c1e79259abea",
"sha256": "11c379a7d6252886ef98219e2c898aef503b514a0b60e4647a762794312597cd"
},
"downloads": -1,
"filename": "ovos_tts_server-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a4f86f76756721e19421c1e79259abea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 13480,
"upload_time": "2025-01-16T00:58:30",
"upload_time_iso_8601": "2025-01-16T00:58:30.448261Z",
"url": "https://files.pythonhosted.org/packages/2f/a0/9c041f4bd8f48aa788a478e65f85b1ad960ca9cc2985b9a05256091ecabc/ovos_tts_server-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c601ca8b826bc9965d4be655e1affc535ae94ae42b16c6d28a7a252dda587f47",
"md5": "1d8119baf5902d7ad8141ac67a74ba5e",
"sha256": "efaad30cc4c9f7da2e14145c93a1b02e9033137192bb02e3a57656dfbe64acb4"
},
"downloads": -1,
"filename": "ovos-tts-server-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "1d8119baf5902d7ad8141ac67a74ba5e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12210,
"upload_time": "2025-01-16T00:58:32",
"upload_time_iso_8601": "2025-01-16T00:58:32.523493Z",
"url": "https://files.pythonhosted.org/packages/c6/01/ca8b826bc9965d4be655e1affc535ae94ae42b16c6d28a7a252dda587f47/ovos-tts-server-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-16 00:58:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenVoiceOS",
"github_project": "ovos-tts-server",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ovos-tts-server"
}
JSON
