项目介绍:ospeak
ospeak 是一个基于命令行接口(CLI)的工具,专为通过 OpenAI 的文本转语音 API 朗读或保存语音结果而设计。这个项目提供了一种便捷的方式,将书写的文本转化为音频,在终端中实现朗读功能。
安装指南
用户可以通过 pipx
安装 ospeak:
pipx install ospeak
对于 MacOS 用户,由于 Python 3.12 的兼容性问题,需要特别注意,建议使用以下命令:
pipx install --python /path/to/python3.11 ospeak
此外,ospeak 也依赖 ffmpeg
,在 macOS 系统上,可以使用 Homebrew 进行安装:
brew install ffmpeg
需要注意的是,ospeak 与某些工具存在依赖冲突,因此推荐使用独立的虚拟环境,通过 pipx
安装以避免这些问题。
使用说明
要让电脑朗读某段文字,可以使用以下命令:
ospeak "Hello there"
使用该工具需要有 OpenAI 的 API 密钥,可以通过环境变量来设置:
export OPENAI_API_KEY="..."
也可以使用 --token
参数传递密钥:
ospeak --token "..." "Hello there"
可以通过管道命令传递文本内容:
echo "Hello there" | ospeak
可以使用 -v/--voice VOICE
来选择不同的语音,默认语音为 alloy
,其他可选语音包括:
echo
fable
onyx
nova
shimmer
如需要听所有语音,各自报出自己的名字,可以传递参数 -v all
:
ospeak "This is my voice" -v all
可以通过 -m/--model
选项选择不同的生成模型,默认模型为 tts-1
,可以使用 -m tts-1-hd
选择更高质量但生成速度较慢的模型:
ospeak "This is higher quality" -m tts-1-hd
调整语音速度,可以传递 -x/--speed
,取值范围为 0.25 到 4,默认值为 1.0:
ospeak "This is my fast voice" -x 2
想要将音频文件写入磁盘时,可以使用 -o/--output
,文件名扩展名支持 .mp3
或 .wav
:
ospeak "This is my voice" -o voice.mp3
如果需要同时朗读和保存,添加 -s/--speak
选项:
ospeak "This is my voice" -o voice.mp3 -s
帮助命令
使用以下命令行选项可以查看帮助信息:
ospeak --help
帮助信息中包括如何设置 API 密钥、声音选项、模型选择等详细的使用方法。
开发与贡献
如果有兴趣为 ospeak 贡献代码,可按以下步骤进行开发:
首先,检出项目代码,然后创建一个新的虚拟环境:
cd ospeak
python -m venv venv
source venv/bin/activate
接下来,安装项目依赖和测试依赖:
pip install -e '.[test]'
最后,运行测试以确保功能正常:
pytest
通过这些步骤,开发者可以更容易上手并为 ospeak 项目贡献自己的力量。