synched with changes from wherever patch

.env.template

@@ -2,8 +2,14 @@ REDDIT_CLIENT_ID=""
 REDDIT_CLIENT_SECRET=""
 REDDIT_USERNAME=""
 REDDIT_PASSWORD=""
-
-# Valid options are "yes" and "no" for the variable below
+# Valid options are "yes" and "no"
 REDDIT_2FA=""
 
+# Valid options are "light" and "dark"
 THEME=""
+
+# Enter a subreddit, e.g. "AskReddit"
+SUBREDDIT=""
+
+# Range is 0 -> 1
+OPACITY="0.9"

README.md

@@ -37,7 +37,7 @@ These videos on TikTok, YouTube and Instagram get MILLIONS of views across all p
 5. Run `python3 main.py`
 6. Enjoy 😎
 
-If you want to see more detailed guide, please refer to the official [documentation](https://immaharry.gitbook.io/reddit-automated-video-bot/).
+If you want to see more detailed guide, please refer to the official [documentation](https://luka-hietala.gitbook.io/documentation-for-the-reddit-bot/).
 *The Documentation is still being developed and worked on, please be patient as we change / add new knowledge!
 
 ## Contributing & Ways to improve 📈

main.py

@@ -1,5 +1,5 @@
 import os
-import time
+import shutil
 
 from dotenv import load_dotenv
 
@@ -12,19 +12,35 @@ from utils.console import print_markdown
 
 
 def main(subreddit_=None, background=None):
+    REQUIRED_VALUES = [
+        "REDDIT_CLIENT_ID",
+        "REDDIT_CLIENT_SECRET",
+        "REDDIT_USERNAME",
+        "REDDIT_PASSWORD",
+        "OPACITY"
+    ]
+
     print_markdown(
         "### Thanks for using this tool! [Feel free to contribute to this project on "
         + "GitHub!](https://lewismenelaws.com) If you have any questions, feel free to"
         + "reach out to me on Twitter or submit a GitHub issue."
     )
 
-    time.sleep(3)
-
-    reddit_object = get_subreddit_threads(subreddit_)
+    if not os.path.exists(".env"):
+        shutil.copy(".env.template", ".env")
+        configured = False
 
     load_dotenv()
-    length, number_of_comments = save_text_to_mp3(reddit_object)
-    download_screenshots_of_reddit_posts(reddit_object, number_of_comments, os.getenv("THEME"))
-    download_background(background)
-    chop_background_video(length)
-    final_video = make_final_video(number_of_comments)
+
+    for val in REQUIRED_VALUES:
+        if not os.getenv(val):
+            print(f"Please set the variable \"{val}\" in your .env file.")
+            configured = False
+
+    if configured:
+        reddit_object = get_subreddit_threads(subreddit_)
+        length, number_of_comments = save_text_to_mp3(reddit_object)
+        download_screenshots_of_reddit_posts(reddit_object, number_of_comments, os.getenv("THEME"))
+        download_background(background)
+        chop_background_video(length)
+        final_video = make_final_video(number_of_comments)

reddit/subreddit.py

@@ -1,5 +1,6 @@
 import random
 import os
+import re
 
 import praw
 from dotenv import load_dotenv
@@ -20,7 +21,7 @@ def get_subreddit_threads(subreddit_):
 
     print_step("Getting AskReddit threads...")
 
-    if os.getenv("REDDIT_2FA").lower() == "yes":
+    if os.getenv("REDDIT_2FA", default="no").casefold() == "yes":
         print(
             "\nEnter your two-factor authentication code from your authenticator app.\n"
         )
@@ -45,7 +46,11 @@ def get_subreddit_threads(subreddit_):
 
         subreddit = reddit.subreddit(subreddit_)
     except ValueError:
-        subreddit = reddit.subreddit("askreddit")
+        if os.getenv("SUBREDDIT"):
+            subreddit = reddit.subreddit(re.sub(r"r\/", "", os.getenv("SUBREDDIT")))
+        else:
+            subreddit = reddit.subreddit("askreddit")
+
         print_substep("Subreddit not defined. Using AskReddit.")
 
     threads = subreddit.hot(limit=25)

video_creation/final_video.py

@@ -1,3 +1,6 @@
+import os
+
+from dotenv import load_dotenv
 from moviepy.editor import (
     VideoFileClip,
     AudioFileClip,
@@ -15,6 +18,10 @@ W, H = 1080, 1920
 
 
 def make_final_video(number_of_clips):
+   # Calls opacity from the .env
+    load_dotenv()
+    opacity = os.getenv("OPACITY")
+
     print_step("Creating the final video...")
     VideoFileClip.reW = lambda clip: clip.resize(width=W)
     VideoFileClip.reH = lambda clip: clip.resize(width=H)
@@ -25,6 +32,12 @@ def make_final_video(number_of_clips):
         .resize(height=H)
         .crop(x1=1166.6, y1=0, x2=2246.6, y2=1920)
     )
+    try:
+        float(os.getenv("OPACITY"))
+    except:
+        print(f"Please ensure that OPACITY is set between 0 and 1 in your .env file")
+        configured = False
+
     # Gather all audio clips
     audio_clips = []
     for i in range(0, number_of_clips):
@@ -41,7 +54,8 @@ def make_final_video(number_of_clips):
             ImageClip(f"assets/png/comment_{i}.png")
             .set_duration(audio_clips[i + 1].duration)
             .set_position("center")
-            .resize(width=W - 100),
+            .resize(width=W - 100)
+            .set_opacity(float(opacity)),
         )
 
     image_clips.insert(
@@ -49,7 +63,8 @@ def make_final_video(number_of_clips):
         ImageClip("assets/png/title.png")
         .set_duration(audio_clips[0].duration)
         .set_position("center")
-        .resize(width=W - 100),
+        .resize(width=W - 100)
+        .set_opacity(float(opacity)),
     )
     image_concat = concatenate_videoclips(image_clips).set_position(
         ("center", "center")

video_creation/voices.py

@@ -25,7 +25,8 @@ def save_text_to_mp3(reddit_obj):
     length += MP3("assets/mp3/title.mp3").info.length
 
     for idx, comment in track(enumerate(reddit_obj["comments"]), "Saving..."):
-        # ! Stop creating mp3 files if the length is greater than 50 seconds. This can be longer, but this is just a good starting point
+        # ! Stop creating mp3 files if the length is greater than 50 seconds.
+        # ! This can be longer, but this is just a good starting point
         if length > 50:
             break
         tts = gTTS(text=comment["comment_body"], lang="en", slow=False)