Merge branch 'master' into filter-comments-by-length

.env.template

@@ -2,15 +2,21 @@ 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=""
 
+
 # Filters the comments by range of lenght (min and max characters)
 # Min has to be less or equal to max
 # DO NOT INSERT ANY SPACES BETWEEN THE COMMA AND THE VALUES
-COMMENT_LENGTH_RANGE = "min,max"
+COMMENT_LENGTH_RANGE = "min,max"
+
+# 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,13 +1,15 @@
 from utils.console import print_markdown
-import time
-
 from reddit.subreddit import get_subreddit_threads
 from video_creation.background import download_background, chop_background_video
 from video_creation.voices import save_text_to_mp3
 from video_creation.screenshot_downloader import download_screenshots_of_reddit_posts
 from video_creation.final_video import make_final_video
 from dotenv import load_dotenv
-import os
+import os, time, shutil
+
+REQUIRED_VALUES = ["REDDIT_CLIENT_ID","REDDIT_CLIENT_SECRET","REDDIT_USERNAME","REDDIT_PASSWORD"]
+
+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."
@@ -15,12 +17,23 @@ print_markdown(
 
 time.sleep(3)
 
+load_dotenv()
 
-reddit_object = get_subreddit_threads()
+configured = True
 
-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()
-chop_background_video(length)
-final_video = make_final_video(number_of_comments)
+if not os.path.exists(".env"):
+    shutil.copy(".env.template", ".env")
+    configured = False
+
+for val in REQUIRED_VALUES:
+    if val not in os.environ or not os.getenv(val):
+        print(f"Please set the variable \"{val}\" in your .env file.")
+        configured = False
+
+if configured:
+    reddit_object = get_subreddit_threads()
+    length, number_of_comments = save_text_to_mp3(reddit_object)
+    download_screenshots_of_reddit_posts(reddit_object, number_of_comments, os.getenv("THEME", "light"))
+    download_background()
+    chop_background_video(length)
+    final_video = make_final_video(number_of_comments)

reddit/subreddit.py

@@ -1,9 +1,7 @@
 from numpy import Infinity
 from utils.console import print_markdown, print_step, print_substep
-import praw
-import random
 from dotenv import load_dotenv
-import os
+import os, random, praw, re
 
 
 def get_subreddit_threads():
@@ -16,7 +14,7 @@ def get_subreddit_threads():
 
     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"
         )
@@ -38,12 +36,12 @@ def get_subreddit_threads():
     )
 
     if os.getenv("SUBREDDIT"):
-        subreddit = reddit.subreddit(os.getenv("SUBREDDIT"))
+        subreddit = reddit.subreddit(re.sub(r"r\/", "", os.getenv("SUBREDDIT")))
     else:
         # ! Prompt the user to enter a subreddit
         try:
             subreddit = reddit.subreddit(
-                input("What subreddit would you like to pull from? ")
+                re.sub(r"r\/", "", input("What subreddit would you like to pull from? "))
             )
         except ValueError:
             subreddit = reddit.subreddit("askreddit")

video_creation/final_video.py

@@ -8,12 +8,18 @@ from moviepy.editor import (
     CompositeVideoClip,
 )
 from utils.console import print_step
-
+from dotenv import load_dotenv
+import os
 
 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)
@@ -24,6 +30,11 @@ 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):
@@ -39,14 +50,16 @@ 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(
         0,
         ImageClip(f"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")