diff --git a/README.md b/README.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..e17f57b628adda2a752643e6bd4038692b9acd0a 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,119 @@ +该项目是一个基于Python的文本转语音(TTS)服务,提供了简单的API接口用于控制和使用TTS功能。以下是项目的基本概述和如何开始使用的说明。 + +--- + +## 📌 项目简介 + +这是一个轻量级的TTS服务,支持通过HTTP接口进行文本转语音处理。项目基于FastAPI构建,具有以下特性: + +- 支持启动和停止TTS服务。 +- 提供获取服务状态的接口。 +- 支持文本转语音功能,自动拆分超长文本。 +- 使用异步生命周期管理,确保资源的正确加载和释放。 + +--- + +## 🧰 技术栈 + +- Python 3.10+ +- FastAPI +- Pydantic +- Uvicorn +- XTTS 模型(用于文本转语音) + +--- + +## 📦 安装步骤 + +### 1. 克隆仓库 + +```bash +git clone https://gitee.com/software-engineering-pre-project/king--wangchao.git +cd king--wangchao +``` + +### 2. 安装依赖 + +```bash +pip install -r requirements.txt +``` + +### 3. 运行服务 + +```bash +uvicorn main:app --reload +``` + +服务默认运行在 `http://127.0.0.1:8000`,你可以访问 `/docs` 查看API文档。 + +--- + +## 🚀 使用说明 + +### API 接口 + +#### 启动服务 + +```http +POST /chat/start +``` + +初始化音频播放器并加载模型。 + +#### 停止服务 + +```http +POST /chat/stop +``` + +释放资源并停止后台线程。 + +#### 获取状态 + +```http +GET /chat/status +``` + +返回服务运行状态、任务队列等信息。 + +#### 文本转语音 + +```http +POST /chat/convert +``` + +提交文本转换请求,自动分段处理并返回任务ID。 + +--- + +## 🧪 测试 + +项目包含一个简单的测试脚本 `test_client.py`,你可以运行以下命令进行测试: + +```bash +python test_client.py +``` + +提供交互模式,方便手动测试不同功能。 + +--- + +## 📄 生成 OpenAPI 文档 + +如果需要生成 OpenAPI JSON 文件,运行: + +```bash +python generate_openapi.py +``` + +--- + +## 📝 许可证 + +该项目遵循 MIT 许可证。有关详细信息,请查看 `LICENSE` 文件。 + +--- + +## 📬 联系方式 + +如需联系作者或提交问题,请参考 Gitee 仓库页面。 \ No newline at end of file