| Name | dimits JSON |
| Version |
0.0.30a0
JSON |
| download |
| home_page | None |
| Summary | Dimits is a Python library that provides an easy-to-use interface to the Piper text-to-speech (TTS) system. It utilizes the powerful Piper TTS engine, which is optimized for Raspberry Pi 4, to generate high-quality synthesized speech. |
| upload_time | 2024-05-04 18:26:43 |
| maintainer | None |
| docs_url | None |
| author | Reqeique |
| requires_python | <4.0,>=3.9 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# **Dimits - Python Bindings for Piper TTS**
Dimits is a Python library that provides an easy-to-use interface to the Piper text-to-speech (TTS) system. It utilizes the powerful Piper TTS engine, which is optimized for Raspberry Pi 4, to generate high-quality synthesized speech.
>
## Features
* Simple Python bindings for Piper TTS
* Support for multiple languages and voices
* Compatible with Raspberry Pi 3/4 and desktop Linux systems
## Installation 📥
You can install Dimits via pip:
```sh
pip install dimits
```
This will automatically install the necessary dependencies
## Quick Start 🏃🏻♀️
Here's a simple example of using Dimits to synthesize speech:
```python
from dimits import Dimits
# Initialize Dimits with the desired voice model
dt = Dimits("en_US-amy-low")
# Convert text to audio and play it using the aplay engine
dt.text_2_speech("Hello World", engine="aplay")
```
## Voices 🔊
Dimits supports all the voices available in the Piper TTS system. To use a specific voice, simply provide corresponding `.onnx` file namepo initializing the `Dimits` class.
For a list of available voices and their download links, refer to the [Piper TTS repository](https://github.com/rhasspy/piper/releases/tag/v0.0.2).
## Usage 📃
### Initializing Dimits
To use Dimits, first create an instance of the `Dimits` class, providing the path to the desired voice model:
```python
from dimits import Dimits
dt = Dimits("en_US-amy-low")
```
### Synthesizing Speech
To synthesize speech and play on the go, simply call the `text_2_speech` method, providing the text to be synthesized and the desired engine:
```python
dt.text_2_speech("This is a test.",engine='aplay')
```
on other hand to synthesize speech and save it to the file, call `text_2_audio_file` finction providing `file_name` `dir` and `format`
```python
dt.text_2_audio_file("Hello World", "hello_world", "/path/to/output/directory/", format="wav")
```
### Changing Voices
To change the voice used for synthesis, create a new instance of the `Dimits` class with the desired voice model:
```python
# dt = Dimits("en_US-amy-low")
dt = Dimits("en_US-danny-low")
```
## TODO 📝
* ~~Implement windows compatible executible to run the voice models~~
* Support for multiple audio player engine
* Benchmark
* Documentation
## License 🪪
This project is licensed under the [MIT License](LICENSE).
## Acknowledgements
Dimits is based on the work of the [Piper](https://github.com/rhasspy/piper) project by [Rhasspy](https://rhasspy.readthedocs.io/en/latest/), and is made possible by the contributions of its developers and the open source community. Without their hard work and dedication, this project would not be possible.
Raw data
{
"_id": null,
"home_page": null,
"name": "dimits",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Reqeique",
"author_email": "ananiyajemberu21@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/04/74/06dec3c5513f932db8ee4a442e6f403eae4ff1fd8d695ad4c60e79ba997f/dimits-0.0.30a0.tar.gz",
"platform": null,
"description": "\n# **Dimits - Python Bindings for Piper TTS**\n\n\nDimits is a Python library that provides an easy-to-use interface to the Piper text-to-speech (TTS) system. It utilizes the powerful Piper TTS engine, which is optimized for Raspberry Pi 4, to generate high-quality synthesized speech.\n> \n## Features\n\n* Simple Python bindings for Piper TTS\n* Support for multiple languages and voices\n* Compatible with Raspberry Pi 3/4 and desktop Linux systems\n\n## Installation \ud83d\udce5\n\nYou can install Dimits via pip:\n\n```sh\npip install dimits\n```\n\nThis will automatically install the necessary dependencies\n\n## Quick Start \ud83c\udfc3\ud83c\udffb\u200d\u2640\ufe0f\n\nHere's a simple example of using Dimits to synthesize speech:\n\n```python\nfrom dimits import Dimits\n\n# Initialize Dimits with the desired voice model\ndt = Dimits(\"en_US-amy-low\")\n\n# Convert text to audio and play it using the aplay engine\ndt.text_2_speech(\"Hello World\", engine=\"aplay\")\n```\n\n## Voices \ud83d\udd0a\n\nDimits supports all the voices available in the Piper TTS system. To use a specific voice, simply provide corresponding `.onnx` file namepo initializing the `Dimits` class.\n\nFor a list of available voices and their download links, refer to the [Piper TTS repository](https://github.com/rhasspy/piper/releases/tag/v0.0.2).\n\n## Usage \ud83d\udcc3\n\n### Initializing Dimits\n\nTo use Dimits, first create an instance of the `Dimits` class, providing the path to the desired voice model:\n\n```python\nfrom dimits import Dimits\n\ndt = Dimits(\"en_US-amy-low\")\n```\n\n### Synthesizing Speech\n\nTo synthesize speech and play on the go, simply call the `text_2_speech` method, providing the text to be synthesized and the desired engine:\n\n```python\ndt.text_2_speech(\"This is a test.\",engine='aplay')\n```\n\non other hand to synthesize speech and save it to the file, call `text_2_audio_file` finction providing `file_name` `dir` and `format`\n\n```python\ndt.text_2_audio_file(\"Hello World\", \"hello_world\", \"/path/to/output/directory/\", format=\"wav\")\n```\n\n### Changing Voices\n\nTo change the voice used for synthesis, create a new instance of the `Dimits` class with the desired voice model:\n\n```python\n# dt = Dimits(\"en_US-amy-low\")\ndt = Dimits(\"en_US-danny-low\")\n```\n## TODO \ud83d\udcdd\n* ~~Implement windows compatible executible to run the voice models~~\n* Support for multiple audio player engine\n* Benchmark\n* Documentation\n\n\n## License \ud83e\udeaa\n\nThis project is licensed under the [MIT License](LICENSE).\n\n## Acknowledgements\nDimits is based on the work of the [Piper](https://github.com/rhasspy/piper) project by [Rhasspy](https://rhasspy.readthedocs.io/en/latest/), and is made possible by the contributions of its developers and the open source community. Without their hard work and dedication, this project would not be possible.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Dimits is a Python library that provides an easy-to-use interface to the Piper text-to-speech (TTS) system. It utilizes the powerful Piper TTS engine, which is optimized for Raspberry Pi 4, to generate high-quality synthesized speech.",
"version": "0.0.30a0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1ac360ea1c6054f28611d6ccb2588194ab649cddaa54fe97ce67d577420586b3",
"md5": "655bc549dfc4d6854351a7c1072264ea",
"sha256": "cc0a391cf98115954e4e0d409d6d7e72a030eca55985cc5a26fc0e8735b6086a"
},
"downloads": -1,
"filename": "dimits-0.0.30a0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "655bc549dfc4d6854351a7c1072264ea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 8584,
"upload_time": "2024-05-04T18:26:42",
"upload_time_iso_8601": "2024-05-04T18:26:42.509926Z",
"url": "https://files.pythonhosted.org/packages/1a/c3/60ea1c6054f28611d6ccb2588194ab649cddaa54fe97ce67d577420586b3/dimits-0.0.30a0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "047406dec3c5513f932db8ee4a442e6f403eae4ff1fd8d695ad4c60e79ba997f",
"md5": "dce98c45a5e42d1e815b72070109e88d",
"sha256": "f1d2d3b8c8e73d2cb55c0f385aa0099a3181ed91cf1a046619ba4cbea5c18511"
},
"downloads": -1,
"filename": "dimits-0.0.30a0.tar.gz",
"has_sig": false,
"md5_digest": "dce98c45a5e42d1e815b72070109e88d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 7269,
"upload_time": "2024-05-04T18:26:43",
"upload_time_iso_8601": "2024-05-04T18:26:43.939073Z",
"url": "https://files.pythonhosted.org/packages/04/74/06dec3c5513f932db8ee4a442e6f403eae4ff1fd8d695ad4c60e79ba997f/dimits-0.0.30a0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-04 18:26:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "dimits"
}
