WhisperWriter 使用教程

WhisperWriter 使用教程

whisper-writer 💬📝 A small dictation app using OpenAI's Whisper speech recognition model. 项目地址: https://gitcode.com/gh_mirrors/wh/whisper-writer

1. 项目目录结构及介绍

WhisperWriter 的项目目录结构如下：

whisper-writer/
├── assets/                    # 存放静态资源
├── src/                       # 源代码目录
│   ├── __init__.py
│   ├── app.py                 # 主应用程序文件
│   ├── config.py              # 配置文件
│   ├── recorder.py            # 录音模块
│   ├── transcriber.py         # 转录模块
│   └── utils.py               # 辅助工具模块
├── .gitignore                 # Git 忽略文件
├── CHANGELOG.md               # 更新日志
├── LICENSE                    # 许可证文件
├── README.md                  # 项目说明文件
├── requirements.txt           # 项目依赖文件
└── run.py                     # 项目启动文件

• assets/：存放项目的静态资源，如图片、样式表等。
• src/：包含项目的所有源代码。
  • app.py：主应用程序文件，负责应用程序的主要逻辑。
  • config.py：配置文件，包含应用程序的所有配置选项。
  • recorder.py：录音模块，负责录音功能。
  • transcriber.py：转录模块，负责语音到文本的转换。
  • utils.py：辅助工具模块，包含一些工具函数。
• .gitignore：指定 Git 忽略的文件和目录。
• CHANGELOG.md：记录项目的更新日志。
• LICENSE：项目使用的许可证信息。
• README.md：项目的说明文件，包含项目的介绍和如何使用。
• requirements.txt：项目依赖的 Python 包列表。
• run.py：项目的启动文件，用于启动应用程序。

2. 项目的启动文件介绍

项目的启动文件是 run.py。这个文件负责初始化和启动 WhisperWriter 应用程序。以下是 run.py 的主要部分：

import sys
from PyQt5.QtWidgets import QApplication
from src.app import WhisperWriterApp

if __name__ == '__main__':
    app = QApplication(sys.argv)
    window = WhisperWriterApp()
    window.show()
    sys.exit(app.exec_())

这段代码首先导入必要的模块，然后创建一个 QApplication 对象。之后，创建 WhisperWriterApp 类的实例，并显示窗口。最后，进入应用程序的主事件循环。

3. 项目的配置文件介绍

项目的配置文件是 config.py。这个文件包含了应用程序的所有配置选项，如 API 密钥、模型设置、语言设置等。以下是 config.py 的主要配置：

# 开发者模式开关
DEBUG = True

# OpenAI API 配置
API_KEY = 'your_openai_api_key'
BASE_URL = 'https://api.openai.com/v1'

# Whisper 模型配置
MODEL = 'base'
DEVICE = 'auto'
COMPUTE_TYPE = 'default'
LANGUAGE = 'zh-CN'
TEMPERATURE = 0.0

# 录音和转录配置
ACTIVATION_KEY = 'ctrl+shift+space'
RECORD_MODE = 'continuous'
VAD_FILTER = True

配置文件中的选项可以根据实际需要进行修改，例如更改 API 密钥、选择不同的模型或设置默认的语言。这些配置将影响应用程序的行为和性能。在开发环境中，可以通过修改 DEBUG 来开启或关闭调试模式。

whisper-writer 💬📝 A small dictation app using OpenAI's Whisper speech recognition model. 项目地址: https://gitcode.com/gh_mirrors/wh/whisper-writer