OpenAI-Spechify-Your-Docs

OpenAI-Spechify-Your-Docs is a powerful Python tool designed to convert text from .txt, .pdf, and .epub files into high-quality speech using OpenAI's Text-to-Speech API. The generated speech is saved as MP3 files, with long texts being split into manageable parts to ensure a seamless listening experience.

Use Case

Whether you're a developer looking to convert technical documentation into audio or a business professional wanting to listen to lengthy reports on the go, this tool is ideal for you. It effortlessly transforms emails, articles, and even book-sized texts into MP3 files, making it perfect for anyone who prefers listening over reading.

Features

• Multi-Format Support: Reads and converts text from .txt, .pdf, and .epub files.
• High-Quality Speech: Utilizes OpenAI's Text-to-Speech API to generate clear and natural-sounding audio.
• Text Splitting: Automatically splits long text into multiple parts and saves each part as an MP3 file if the duration exceeds 30 minutes.

Installation

Clone the repository

git clone https://github.com/Thukyd/OpenAI-Spechify-Your-Docs.git
cd OpenAI-Spechify-Your-Docs

Create and activate a virtual environment (optional but recommended)

python -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`

Install the required dependencies

pip install -r requirements.txt

Set up your OpenAI API key

Create a .env file in the project root directory and add your OpenAI API key:

OPENAI_API_KEY=your_openai_api_key

Usage

Place your text files in the sources directory

Ensure your .txt, .pdf, and .epub files are in the sources directory.

Run the script

python main.py

Check the outputs directory for the generated MP3 files

The MP3 files will be saved in subdirectories named after the original text files, with filenames indicating the total number of parts.

Customize the script

• You can change the max_duration variable in the script to adjust the maximum duration of each MP3 file.
• You can also decide if you want to keep the intermediate MP3 files by setting the delete_downloads variable to True or False.
• You can choose another OpenAI voice, the default is shimmer but there is a range of alternative voices available.

Dependencies

• requests
• PyPDF2
• ebooklib
• beautifulsoup4
• python-dotenv
• tqdm (for displaying a progress bar)
• pydub (for audio merging)
• mutagen (metadata editing - e.g. image embedding)

Additionally, you need to have ffmpeg installed on your system. You can install it using:

• On macOS: brew install ffmpeg
• On Ubuntu: sudo apt-get install ffmpeg
• On Windows: Download and install from the FFmpeg website.

OpenAI Costs and Usage Policies

Please note that using the OpenAI Text-to-Speech API incurs costs. You can find the latest pricing under Audio Models.

Ensure you comply with OpenAI's usage policies. Users of this script should read these policies before running it.

Contributing

If you find any issues or have suggestions for improvements, feel free to open an issue or create a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.