PDF2Audio 使用与配置指南

PDF2Audio 使用与配置指南

PDF2Audio 项目地址: https://gitcode.com/gh_mirrors/pd/PDF2Audio

1. 项目目录结构及介绍

PDF2Audio 项目是一个开源项目，用于将 PDF 文档转换为音频文件。项目的主要目录结构如下：

• LICENSE: 项目使用的 Apache-2.0 许可证文件。
• README.md: 项目说明文件，包含项目介绍、功能、使用方法等信息。
• PDF2Audio.ipynb: Jupyter 笔记本文件，用于演示项目的主要功能。
• app.py: 项目的主要启动文件，用于启动 Gradio 界面。
• logo.png: 项目图标文件。
• requirements.txt: 项目依赖文件，列出了运行项目所需的 Python 库。
• SciAgents discovery summary - example.mp3: 示例音频文件，展示项目转换结果。

2. 项目的启动文件介绍

项目的启动文件是 app.py。该文件负责启动 Gradio 界面，用户可以通过该界面上传 PDF 文件并进行转换。

以下是 app.py 文件的主要代码结构：

# 导入必要的库
import gradio as gr

# 定义转换函数
def generate_audio(pdf_file, template, customize_text, voice):
    # 调用相关库函数进行 PDF 转换为音频
    # ...
    return audio_file

# 创建 Gradio 接口
iface = gr.Interface(
    fn=generate_audio,
    inputs=[
        gr.inputs.File(label="Upload PDF"),
        gr.inputs.Dropdown(label="Template", choices=["Podcast", "Lecture", "Summary"]),
        gr.inputs.Textbox(label="Customize Text"),
        gr.inputs.Dropdown(label="Voice", choices=["Alice", "Bob"])
    ],
    outputs="audio"
)

# 启动 Gradio 界面
iface.launch()

3. 项目的配置文件介绍

项目的配置文件主要是 .env 文件，用于存储 OpenAI API key。在项目根目录下创建 .env 文件，并按照以下格式添加你的 OpenAI API key：

OPENAI_API_KEY=your_api_key_here

确保 .env 文件的内容是正确的，因为项目运行时将使用该 API key 来调用 OpenAI 的服务。

在启动项目前，确保你已经按照 requirements.txt 文件中的依赖安装了所有必要的 Python 库，并且已经创建了相应的 Conda 环境。按照以下步骤操作：

• 克隆项目仓库：git clone https://github.com/lamm-mit/PDF2Audio.git
• 进入项目目录：cd PDF2Audio
• 安装 Miniconda（如果尚未安装）
• 验证 Conda 安装：conda --version
• 创建新的 Conda 环境：conda create -n pdf2audio python=3.9
• 激活 Conda 环境：conda activate pdf2audio
• 安装依赖：pip install -r requirements.txt
• 创建 .env 文件并添加 OpenAI API key

完成上述步骤后，你可以通过运行 python app.py 启动项目，并通过浏览器访问提供的 URL 来使用 Gradio 界面。

PDF2Audio 项目地址: https://gitcode.com/gh_mirrors/pd/PDF2Audio