gTTS 项目技术文档

gTTS 项目技术文档

gTTS Python library and CLI tool to interface with Google Translate's text-to-speech API 项目地址: https://gitcode.com/gh_mirrors/gt/gTTS

1. 安装指南

1.1 系统要求

• Python 3.7 或更高版本
• 支持的操作系统：Windows, macOS, Linux

1.2 安装步骤

使用 pip 安装 gTTS 库：

$ pip install gTTS

2. 项目使用说明

2.1 命令行使用

通过命令行工具 gtts-cli 可以将文本转换为语音并保存为 MP3 文件。

示例：

$ gtts-cli '你好，世界！' --output hello.mp3

2.2 模块使用

在 Python 脚本中使用 gTTS 模块进行文本到语音的转换。

示例：

from gtts import gTTS

# 创建 gTTS 对象
tts = gTTS('你好，世界！')

# 保存为 MP3 文件
tts.save('hello.mp3')

3. 项目 API 使用文档

3.1 gTTS 类

gTTS 类是 gTTS 库的核心类，用于将文本转换为语音。

3.1.1 初始化

gTTS(text, lang='zh', slow=False, lang_check=True)

• text: 要转换的文本字符串。
• lang: 语言代码，默认为 'zh'（中文）。
• slow: 是否以较慢的速度朗读，默认为 False。
• lang_check: 是否检查语言代码的有效性，默认为 True。

3.1.2 方法

• save(file_name): 将生成的语音保存为 MP3 文件。
  • file_name: 保存的文件名。

3.2 gtts-cli 命令行工具

gtts-cli 是一个命令行工具，用于快速将文本转换为语音。

3.2.1 常用参数

• --text: 要转换的文本。
• --lang: 语言代码，默认为 'zh'。
• --output: 输出文件名。

示例：

$ gtts-cli --text '你好，世界！' --lang zh --output hello.mp3

4. 项目安装方式

4.1 使用 pip 安装

$ pip install gTTS

4.2 从源码安装

1. 克隆项目仓库：

   $ git clone https://github.com/pndurette/gTTS.git
   

2. 进入项目目录：

   $ cd gTTS
   

3. 安装依赖：

   $ pip install -r requirements.txt
   

4. 安装 gTTS：

   $ python setup.py install
   

5. 项目链接

• GitHub 仓库
• 文档
• PyPI 页面

6. 免责声明

本项目与 Google 或 Google Cloud 无关。由于上游变化，可能会出现中断。本项目利用了 Google Translate 的未记录语音功能，与 Google Cloud Text-to-Speech 不同。

7. 许可证

本项目采用 MIT 许可证。详细信息请参阅 LICENSE 文件。

---

通过以上文档，您可以轻松安装和使用 gTTS 项目，将文本转换为语音。如有任何问题，请参考项目文档或访问 GitHub 仓库获取更多帮助。

gTTS Python library and CLI tool to interface with Google Translate's text-to-speech API 项目地址: https://gitcode.com/gh_mirrors/gt/gTTS