chore: release 3.4.0

.dockerignore

@@ -1 +1,2 @@
-Dockerfile
+Dockerfile
+results

.python-version

@@ -0,0 +1 @@
+3.10

README.md

@@ -37,27 +37,61 @@ The only original thing being done is the editing and gathering of all materials
 
 ## Installation 👩‍💻
 
-1. Clone this repository
-2. Run `pip install -r requirements.txt`
-3. Run `python -m playwright install` and `python -m playwright install-deps`
+1. Clone this repository:
+    ```sh
+    git clone https://github.com/elebumm/RedditVideoMakerBot.git
+    cd RedditVideoMakerBot
+    ```
+
+2. Create and activate a virtual environment:
+    - On **Windows**:
+        ```sh
+        python -m venv ./venv
+        .\venv\Scripts\activate
+        ```
+    - On **macOS and Linux**:
+        ```sh
+        python3 -m venv ./venv
+        source ./venv/bin/activate
+        ```
+
+3. Install the required dependencies:
+    ```sh
+    pip install -r requirements.txt
+    ```
+
+4. Install Playwright and its dependencies:
+    ```sh
+    python -m playwright install
+    python -m playwright install-deps
+    ```
+
+---
 
 **EXPERIMENTAL!!!!**
 
-On macOS and Linux (debian, arch, fedora and centos, and based on those), you can run an install script that will automatically install steps 1 to 3. (requires bash)
+   - On macOS and Linux (Debian, Arch, Fedora, CentOS, and based on those), you can run an installation script that will automatically install steps 1 to 3. (requires bash)
+   - `bash <(curl -sL https://raw.githubusercontent.com/elebumm/RedditVideoMakerBot/master/install.sh)`
+   - This can also be used to update the installation
 
-`bash <(curl -sL https://raw.githubusercontent.com/elebumm/RedditVideoMakerBot/master/install.sh)`
+---
 
-This can also be used to update the installation
+5. Run the bot:
+    ```sh
+    python main.py
+    ```
 
-4. Run `python main.py`
-5. Visit [the Reddit Apps page.](https://www.reddit.com/prefs/apps), and set up an app that is a "script". Paste any URL in redirect URL. Ex:`https://jasoncameron.dev`
-6. The bot will ask you to fill in your details to connect to the Reddit API, and configure the bot to your liking
-7. Enjoy 😎
-8. If you need to reconfigure the bot, simply open the `config.toml` file and delete the lines that need to be changed. On the next run of the bot, it will help you reconfigure those options.
+6. Visit [the Reddit Apps page](https://www.reddit.com/prefs/apps), and set up an app that is a "script". Paste any URL in the redirect URL field, for example: `https://jasoncameron.dev`.
 
-(Note if you got an error installing or running the bot try first rerunning the command with a three after the name e.g. python3 or pip3)
+7. The bot will prompt you to fill in your details to connect to the Reddit API and configure the bot to your liking.
 
-If you want to read more detailed guide about the bot, please refer to the [documentation](https://reddit-video-maker-bot.netlify.app/)
+8. Enjoy 😎
+
+9. If you need to reconfigure the bot, simply open the `config.toml` file and delete the lines that need to be changed. On the next run of the bot, it will help you reconfigure those options.
+
+(Note: If you encounter any errors installing or running the bot, try using `python3` or `pip3` instead of `python` or `pip`.)
+
+For a more detailed guide about the bot, please refer to the [documentation](https://reddit-video-maker-bot.netlify.app/).
 
 ## Video
 

TTS/GTTS.py

@@ -10,7 +10,7 @@ def __init__(self):
         self.max_chars = 5000
         self.voices = []
 
-    def run(self, text, filepath):
+    def run(self, text, filepath, random_voice: bool = False):
         tts = gTTS(
             text=text,
             lang=settings.config["reddit"]["thread"]["post_lang"] or "en",

TTS/elevenlabs.py

@@ -35,4 +35,4 @@ def initialize(self):
     def randomvoice(self):
         if self.client is None:
             self.initialize()
-        return random.choice(self.client.voices.get_all().voices).voice_name
+        return random.choice(self.client.voices.get_all().voices).name

TTS/engine_wrapper.py

@@ -5,9 +5,9 @@
 
 import numpy as np
 import translators
+from moviepy import AudioFileClip
 from moviepy.audio.AudioClip import AudioClip
-from moviepy.audio.fx.volumex import volumex
-from moviepy.editor import AudioFileClip
+from moviepy.audio.fx import MultiplyVolume
 from rich.progress import track
 
 from utils import settings
@@ -112,7 +112,6 @@ def split_post(self, text: str, idx):
         ]
         self.create_silence_mp3()
 
-        idy = None
         for idy, text_cut in enumerate(split_text):
             newtext = process_text(text_cut)
             # print(f"{idx}-{idy}: {newtext}\n")
@@ -144,11 +143,18 @@ def split_post(self, text: str, idx):
             print("OSError")
 
     def call_tts(self, filename: str, text: str):
-        self.tts_module.run(
-            text,
-            filepath=f"{self.path}/{filename}.mp3",
-            random_voice=settings.config["settings"]["tts"]["random_voice"],
-        )
+        if settings.config["settings"]["tts"]["voice_choice"] == "googletranslate":
+            # GTTS does not have the argument 'random_voice'
+            self.tts_module.run(
+                text,
+                filepath=f"{self.path}/{filename}.mp3",
+            )
+        else:
+            self.tts_module.run(
+                text,
+                filepath=f"{self.path}/{filename}.mp3",
+                random_voice=settings.config["settings"]["tts"]["random_voice"],
+            )
         # try:
         #     self.length += MP3(f"{self.path}/{filename}.mp3").info.length
         # except (MutagenError, HeaderNotFoundError):
@@ -164,12 +170,12 @@ def call_tts(self, filename: str, text: str):
     def create_silence_mp3(self):
         silence_duration = settings.config["settings"]["tts"]["silence_duration"]
         silence = AudioClip(
-            make_frame=lambda t: np.sin(440 * 2 * np.pi * t),
+            frame_function=lambda t: np.sin(440 * 2 * np.pi * t),
             duration=silence_duration,
             fps=44100,
         )
-        silence = volumex(silence, 0)
-        silence.write_audiofile(f"{self.path}/silence.mp3", fps=44100, verbose=False, logger=None)
+        silence = silence.with_effects([MultiplyVolume(0)])
+        silence.write_audiofile(f"{self.path}/silence.mp3", fps=44100, logger=None)
 
 
 def process_text(text: str, clean: bool = True):

TTS/openai_tts.py

@@ -0,0 +1,91 @@
+import random
+
+import requests
+
+from utils import settings
+
+
+class OpenAITTS:
+    """
+    A Text-to-Speech engine that uses an OpenAI-like TTS API endpoint to generate audio from text.
+
+    Attributes:
+        max_chars (int): Maximum number of characters allowed per API call.
+        api_key (str): API key loaded from settings.
+        api_url (str): The complete API endpoint URL, built from a base URL provided in the config.
+        available_voices (list): Static list of supported voices (according to current docs).
+    """
+
+    def __init__(self):
+        # Set maximum input size based on API limits (4096 characters per request)
+        self.max_chars = 4096
+        self.api_key = settings.config["settings"]["tts"].get("openai_api_key")
+        if not self.api_key:
+            raise ValueError(
+                "No OpenAI API key provided in settings! Please set 'openai_api_key' in your config."
+            )
+
+        # Lese den Basis-URL aus der Konfiguration (z. B. "https://api.openai.com/v1" oder "https://api.openai.com/v1/")
+        base_url = settings.config["settings"]["tts"].get(
+            "openai_api_url", "https://api.openai.com/v1"
+        )
+        # Entferne ggf. den abschließenden Slash
+        if base_url.endswith("/"):
+            base_url = base_url[:-1]
+        # Hänge den TTS-spezifischen Pfad an
+        self.api_url = base_url + "/audio/speech"
+
+        # Set the available voices to a static list as per OpenAI TTS documentation.
+        self.available_voices = self.get_available_voices()
+
+    def get_available_voices(self):
+        """
+        Return a static list of supported voices for the OpenAI TTS API.
+
+        According to the documentation, supported voices include:
+            "alloy", "ash", "coral", "echo", "fable", "onyx", "nova", "sage", "shimmer"
+        """
+        return ["alloy", "ash", "coral", "echo", "fable", "onyx", "nova", "sage", "shimmer"]
+
+    def randomvoice(self):
+        """
+        Select and return a random voice from the available voices.
+        """
+        return random.choice(self.available_voices)
+
+    def run(self, text, filepath, random_voice: bool = False):
+        """
+        Convert the provided text to speech and save the resulting audio to the specified filepath.
+
+        Args:
+            text (str): The input text to convert.
+            filepath (str): The file path where the generated audio will be saved.
+            random_voice (bool): If True, select a random voice from the available voices.
+        """
+        # Choose voice based on configuration or randomly if requested.
+        if random_voice:
+            voice = self.randomvoice()
+        else:
+            voice = settings.config["settings"]["tts"].get("openai_voice_name", "alloy")
+            voice = str(voice).lower()  # Ensure lower-case as expected by the API
+
+        # Select the model from configuration; default to 'tts-1'
+        model = settings.config["settings"]["tts"].get("openai_model", "tts-1")
+
+        # Create Payload for API-request
+        payload = {
+            "model": model,
+            "voice": voice,
+            "input": text,
+            "response_format": "mp3",  # allowed formats: "mp3", "aac", "opus", "flac", "pcm" or "wav"
+        }
+        headers = {"Authorization": f"Bearer {self.api_key}", "Content-Type": "application/json"}
+        try:
+            response = requests.post(self.api_url, headers=headers, json=payload)
+            if response.status_code != 200:
+                raise RuntimeError(f"Error from TTS API: {response.status_code} {response.text}")
+            # Write response as binary into file.
+            with open(filepath, "wb") as f:
+                f.write(response.content)
+        except Exception as e:
+            raise RuntimeError(f"Failed to generate audio with OpenAI TTS API: {str(e)}")

main.py

@@ -4,7 +4,7 @@
 from os import name
 from pathlib import Path
 from subprocess import Popen
-from typing import NoReturn
+from typing import Dict, NoReturn
 
 from prawcore import ResponseException
 
@@ -13,7 +13,7 @@
 from utils.cleanup import cleanup
 from utils.console import print_markdown, print_step, print_substep
 from utils.ffmpeg_install import ffmpeg_install
-from utils.id import id
+from utils.id import extract_id
 from utils.version import checkversion
 from video_creation.background import (
     chop_background,
@@ -25,7 +25,7 @@
 from video_creation.screenshot_downloader import get_screenshots_of_reddit_posts
 from video_creation.voices import save_text_to_mp3
 
-__VERSION__ = "3.3.0"
+__VERSION__ = "3.4.0"
 
 print(
     """
@@ -42,11 +42,15 @@
 )
 checkversion(__VERSION__)
 
+reddit_id: str
+reddit_object: Dict[str, str | list]
+
 
 def main(POST_ID=None) -> None:
-    global redditid, reddit_object
+    global reddit_id, reddit_object
     reddit_object = get_subreddit_threads(POST_ID)
-    redditid = id(reddit_object)
+    reddit_id = extract_id(reddit_object)
+    print_substep(f"Thread ID is {reddit_id}", style="bold blue")
     length, number_of_comments = save_text_to_mp3(reddit_object)
     length = math.ceil(length)
     get_screenshots_of_reddit_posts(reddit_object, number_of_comments)
@@ -64,22 +68,22 @@ def run_many(times) -> None:
     for x in range(1, times + 1):
         print_step(
             f'on the {x}{("th", "st", "nd", "rd", "th", "th", "th", "th", "th", "th")[x % 10]} iteration of {times}'
-        )  # correct 1st 2nd 3rd 4th 5th....
+        )
         main()
         Popen("cls" if name == "nt" else "clear", shell=True).wait()
 
 
 def shutdown() -> NoReturn:
-    if "redditid" in globals():
+    if "reddit_id" in globals():
         print_markdown("## Clearing temp files")
-        cleanup(redditid)
+        cleanup(reddit_id)
 
     print("Exiting...")
     sys.exit()
 
 
 if __name__ == "__main__":
-    if sys.version_info.major != 3 or sys.version_info.minor not in [10, 11]:
+    if sys.version_info.major != 3 or sys.version_info.minor not in [10, 11, 12]:
         print(
             "Hey! Congratulations, you've made it so far (which is pretty rare with no Python 3.10). Unfortunately, this program only works on Python 3.10. Please install Python 3.10 and try again."
         )
@@ -122,6 +126,7 @@ def shutdown() -> NoReturn:
     except Exception as err:
         config["settings"]["tts"]["tiktok_sessionid"] = "REDACTED"
         config["settings"]["tts"]["elevenlabs_api_key"] = "REDACTED"
+        config["settings"]["tts"]["openai_api_key"] = "REDACTED"
         print_step(
             f"Sorry, something went wrong with this version! Try again, and feel free to report this issue at GitHub or the Discord community.\n"
             f"Version: {__VERSION__} \n"

requirements.txt

@@ -1,24 +1,21 @@
-boto3==1.34.127
-botocore==1.34.127
-gTTS==2.5.1
-moviepy==1.0.3
-playwright==1.44.0
-praw==7.7.1
-prawcore~=2.3.0
+boto3==1.36.8
+botocore==1.36.8
+gTTS==2.5.4
+moviepy==2.1.2
+playwright==1.49.1
+praw==7.8.1
 requests==2.32.3
-rich==13.7.1
+rich==13.9.4
 toml==0.10.2
-translators==5.9.2
-pyttsx3==2.90
-Pillow==10.3.0
-tomlkit==0.12.5
-Flask==3.0.3
+translators==5.9.9
+pyttsx3==2.98
+tomlkit==0.13.2
+Flask==3.1.0
 clean-text==0.6.0
-unidecode==1.3.8
-spacy==3.7.5
-torch==2.3.1
-transformers==4.41.2
+unidecode==1.4.0
+spacy==3.8.7
+torch==2.7.0
+transformers==4.52.3
 ffmpeg-python==0.2.0
-elevenlabs==1.3.0
-yt-dlp==2024.5.27
-numpy==1.26.4
+elevenlabs==1.57.0
+yt-dlp==2025.5.22

utils/.config.template.toml

@@ -44,7 +44,6 @@ background_thumbnail_font_size = { optional = true, type = "int", default = 96,
 background_thumbnail_font_color = { optional = true, default = "255,255,255", example = "255,255,255", explanation = "Font color in RGB format for the thumbnail text" }
 
 [settings.tts]
-voice_choice = { optional = false, default = "tiktok", options = ["elevenlabs", "streamlabspolly", "tiktok", "googletranslate", "awspolly", "pyttsx", ], example = "tiktok", explanation = "The voice platform used for TTS generation. " }
 random_voice = { optional = false, type = "bool", default = true, example = true, options = [true, false,], explanation = "Randomizes the voice used for each comment" }
 elevenlabs_voice_name = { optional = false, default = "Bella", example = "Bella", explanation = "The voice used for elevenlabs", options = ["Adam", "Antoni", "Arnold", "Bella", "Domi", "Elli", "Josh", "Rachel", "Sam", ] }
 elevenlabs_api_key = { optional = true, example = "21f13f91f54d741e2ae27d2ab1b99d59", explanation = "Elevenlabs API key" }
@@ -56,3 +55,7 @@ python_voice = { optional = false, default = "1", example = "1", explanation = "
 py_voice_num = { optional = false, default = "2", example = "2", explanation = "The number of system voices (2 are pre-installed in Windows)" }
 silence_duration = { optional = true, example = "0.1", explanation = "Time in seconds between TTS comments", default = 0.3, type = "float" }
 no_emojis = { optional = false, type = "bool", default = false, example = false, options = [true, false,], explanation = "Whether to remove emojis from the comments" }
+openai_api_url = { optional = true, default = "https://api.openai.com/v1/", example = "https://api.openai.com/v1/", explanation = "The API endpoint URL for OpenAI TTS generation" }
+openai_api_key = { optional = true, example = "sk-abc123def456...", explanation = "Your OpenAI API key for TTS generation" }
+openai_voice_name = { optional = false, default = "alloy", example = "alloy", explanation = "The voice used for OpenAI TTS generation", options = ["alloy", "ash", "coral", "echo", "fable", "onyx", "nova", "sage", "shimmer", "af_heart"] }
+openai_model = { optional = false, default = "tts-1", example = "tts-1", explanation = "The model variant used for OpenAI TTS generation", options = ["tts-1", "tts-1-hd", "gpt-4o-mini-tts"] }