A package to make kokoro simpler to work with
Project description
SimplerKokoro
Effortless speech synthesis with Kokoro, in Python.
✨ Features
- Simple interface for generating speech audio and subtitles
- Supports all Kokoro voices
- Outputs valid SRT subtitles
- Automatic Model Management
🚀 Installation
From PyPI:
pip install Simpler-Kokoro
Or clone the repo and install locally:
git clone https://github.com/WilleIshere/SimplerKokoro.git
cd SimplerKokoro
pip install .
📦 Requirements
- Python 3.10+
- torch
- kokoro
- soundfile
All dependencies except Python are installed automatically.
🧑💻 Examples
You can find runnable example scripts in the examples/ folder:
basic_example.py: Basic usage, generate speech from text.subtitles_example.py: Generate speech with SRT subtitles.custom_speed_example.py: Generate speech with custom speed.custom_models_dir_example.py: Specify a custom directory for model downloads.
🛠️ Usage
Basic Example
from Simpler_Kokoro import SimplerKokoro
# Create an instance
sk = SimplerKokoro()
# List available voices
voices = sk.list_voices()
print("Available voices:", [v['name'] for v in voices])
# Generate speech
sk.generate(
text="Hello, this is a test of the Simpler Kokoro voice synthesis.",
voice=voices[0]['name'],
output_path="output.wav"
)
Generate Speech with Subtitles
sk.generate(
text="Hello, this is a test. This is another sentence.",
voice=voices[0]['name'],
output_path="output.wav",
write_subtitles=True,
subtitles_path="output.srt",
subtititles_word_level=True
)
Generate Speech with Custom Speed
sk.generate(
text="This is spoken faster than normal.",
voice=voices[1]['name'],
output_path="fast_output.wav",
speed=1.5
)
Specify a Path to Download Models
sk.generate(
models_dir="Folder-to-put-models-in",
text="Thats a cool model directory.",
voice=voices[1]['name'],
output_path="fast_output.wav",
)
📂 Example Output Files
output.wav: The synthesized speech audio file.output.srt: Subtitles in SRT format (ifwrite_subtitles=True).
Sample SRT output
1
00:00:00,000 --> 00:00:01,200
Hello,
2
00:00:01,200 --> 00:00:02,500
this is a test.
3
00:00:02,500 --> 00:00:04,000
This is another sentence.
📖 API
SimplerKokoro
Methods
list_voices(): Returns a list of available voices with metadata.generate(text, voice, output_path, speed=1.0, write_subtitles=False, subtitles_path='subtitles.srt', subtititles_word_level=False): Generates speech audio and optional subtitles.
📄 License
This project is licensed under the GPL-3.0 license.
⭐ Star History
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file simpler_kokoro-1.1.1.tar.gz.
File metadata
- Download URL: simpler_kokoro-1.1.1.tar.gz
- Upload date:
- Size: 18.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
80f16946a62f958814d3e9adfc962cd7161f94d4e4166fdb73f55321644566f9
|
|
| MD5 |
39210295100204df7c518a695d25e35b
|
|
| BLAKE2b-256 |
62087559e5047eb2e33145198c466824aa03dfd6aa4b50d066bac392acbd9e73
|
File details
Details for the file simpler_kokoro-1.1.1-py3-none-any.whl.
File metadata
- Download URL: simpler_kokoro-1.1.1-py3-none-any.whl
- Upload date:
- Size: 18.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3ee9068359e71f4bf0b5412ff5a2579f998575e63494e54da7d75078a3aaec14
|
|
| MD5 |
ca9a8c88864b99b3c16ca17c996308d4
|
|
| BLAKE2b-256 |
4c83f4d1a616eb82aa510b75986139d3193b52d99b03c26943ff8fea9a80f7ab
|