跳转到主要内容

OpenAI 文本到语音的CLI工具

项目描述

ospeak

PyPI Changelog Tests License

CLI工具,通过OpenAI 文本到语音 API运行文本,并说话或保存结果

有关此项目的背景信息,请参阅ospeak:使用OpenAI在终端中说话的CLI工具

安装

使用pipx安装此工具

pipx install ospeak

注意,在MacOS上,与Python 3.12存在已损坏的依赖项,因此请改为运行

pipx install --python /path/to/python3.11 ospeak

此工具还依赖于ffmpeg。您可以使用Homebrew在macOS上安装它,如下所示

brew install ffmpeg

请注意,ospeak的依赖项目前与LLM(见此问题)不兼容,因此这两个工具需要在不同的虚拟环境中安装,因此建议使用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

Usage: ospeak [OPTIONS] [TEXT]

  CLI tool for running text through OpenAI Text to speech

  Set the OPENAI_API_KEY environment variable to your OpenAI API key to avoid
  using the --token option every time.

  Example usage:

      ospeak "Everyone deserves a pelican" --voice alloy -x 1.5

Options:
  --version                       Show the version and exit.
  -v, --voice [alloy|echo|fable|onyx|nova|shimmer|all]
                                  Voice to use
  -m, --model TEXT                Model to use - defaults to tts-1
  -o, --output FILE               Save audio to this file on disk
  -x, --speed FLOAT RANGE         Speed of the voice  [0.25<=x<=4.0]
  -s, --speak                     Speak the text even when saving to a file
  --token TEXT                    OpenAI API key
  --help                          Show this message and exit.

开发

要为此工具做出贡献,首先检出代码。然后创建一个新的虚拟环境。

cd ospeak
python -m venv venv
source venv/bin/activate

现在安装依赖项和测试依赖项。

pip install -e '.[test]'

要运行测试

pytest

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。

源分发

ospeak-0.3.tar.gz (8.8 kB 查看哈希)

上传时间

构建分发

ospeak-0.3-py3-none-any.whl (9.2 kB 查看哈希)

上传时间 Python 3

由以下机构支持