Merge remote-tracking branch 'upstream/master' into filter-comments-by-length

.env.template

@@ -1,16 +1,25 @@
 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=""
 
+#If no, it will ask you a thread link to extract the thread, if yes it will randomize it. 
+RANDOM_THREAD="no"
+
+# 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"

.gitignore

@@ -2,4 +2,6 @@ assets/
 .env
 reddit-bot-351418-5560ebc49cac.json
 __pycache__
-out
+.idea/
+.DS_Store
+out

README.md

@@ -7,6 +7,7 @@ All done WITHOUT video editing or asset compiling. Just pure ✨programming magi
 Created by Lewis Menelaws & [TMRRW](https://tmrrwinc.ca)
 
 [<picture>
+
   <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/6053155/170528535-e274dc0b-7972-4b27-af22-637f8c370133.png">
   <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/6053155/170528582-cb6671e7-5a2f-4bd4-a048-0e6cfa54f0f7.png">
   <img src="https://user-images.githubusercontent.com/6053155/170528582-cb6671e7-5a2f-4bd4-a048-0e6cfa54f0f7.png" width="350">
@@ -20,13 +21,13 @@ These videos on TikTok, YouTube and Instagram get MILLIONS of views across all p
 
 ## Disclaimers 🚨
 
-- This is purely for fun purposes.
+-   This is purely for fun purposes.
-- **At the moment**, this repository won't attempt to upload this content through this bot. It will give you a file that you will then have to upload manually. This is for the sake of avoiding any sort of community guideline issues.
+-   **At the moment**, this repository won't attempt to upload this content through this bot. It will give you a file that you will then have to upload manually. This is for the sake of avoiding any sort of community guideline issues.
 
 ## Requirements
 
-- Python 3.6+
+-   Python 3.6+
-- Playwright (this should install automatically during installation)
+-   Playwright (this should install automatically during installation)
 
 ## Installation 👩‍💻
 
@@ -37,8 +38,8 @@ 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!
+\*The Documentation is still being developed and worked on, please be patient as we change / add new knowledge!
 
 ## Contributing & Ways to improve 📈
 
@@ -46,8 +47,8 @@ In its current state, this bot does exactly what it needs to do. However, lots o
 
 I have tried to simplify the code so anyone can read it and start contributing at any skill level. Don't be shy :) contribute!
 
-- [ ] Allowing users to choose a reddit thread instead of being randomized.
+-   [x] Allowing users to choose a reddit thread instead of being randomized.
-- [ ] Allowing users to choose a background that is picked instead of the Minecraft one.
+-   [ ] Allowing users to choose a background that is picked instead of the Minecraft one.
-- [x] Allowing users to choose between any subreddit.
+-   [x] Allowing users to choose between any subreddit.
-- [ ] Allowing users to change voice.
+-   [ ] Allowing users to change voice.
-- [ ] Creating better documentation and adding a command line interface.
+-   [ ] Creating better documentation and adding a command line interface.

main.py

@@ -1,13 +1,13 @@
 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", "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 +15,29 @@ print_markdown(
 
 time.sleep(3)
 
+load_dotenv()
 
-reddit_object = get_subreddit_threads()
+configured = True
 
-load_dotenv()
+if not os.path.exists(".env"):
-length, number_of_comments = save_text_to_mp3(reddit_object)
+    shutil.copy(".env.template", ".env")
-download_screenshots_of_reddit_posts(reddit_object, number_of_comments, os.getenv("THEME"))
+    configured = False
-download_background()
+
-chop_background_video(length)
+for val in REQUIRED_VALUES:
-final_video = make_final_video(number_of_comments)
+    if val not in os.environ or not os.getenv(val):
+        print(f"Please set the variable \"{val}\" in your .env file.")
+        configured = False
+
+try:
+    float(os.getenv("OPACITY"))
+except:
+    print(f"Please ensure that OPACITY is set between 0 and 1 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,22 +1,18 @@
 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():
-
+    global submission
     """
     Returns a list of threads from the AskReddit subreddit.
     """
 
     load_dotenv()
 
-    print_step("Getting AskReddit threads...")
+    if os.getenv("REDDIT_2FA", default="no").casefold() == "yes":
-
-    if os.getenv("REDDIT_2FA").lower() == "yes":
         print(
             "\nEnter your two-factor authentication code from your authenticator app.\n"
         )
@@ -36,33 +32,48 @@ def get_subreddit_threads():
         username=os.getenv("REDDIT_USERNAME"),
         password=passkey,
     )
-
+    # If the user specifies that he doesnt want a random thread, or if he doesn't insert the "RANDOM_THREAD" variable at all, ask the thread link
-    if os.getenv("SUBREDDIT"):
+    if not os.getenv("RANDOM_THREAD") or os.getenv("RANDOM_THREAD") == "no":
-        subreddit = reddit.subreddit(os.getenv("SUBREDDIT"))
+        print_substep("Insert the full thread link:", style="bold green")
+        thread_link = input()
+        print_step(f"Getting the inserted thread...")
+        submission = reddit.submission(url=thread_link)
     else:
-        # ! Prompt the user to enter a subreddit
+        # Otherwise, picks a random thread from the inserted subreddit
-        try:
+        if os.getenv("SUBREDDIT"):
-            subreddit = reddit.subreddit(
+            subreddit = reddit.subreddit(re.sub(r"r\/", "", os.getenv("SUBREDDIT")))
-                input("What subreddit would you like to pull from? ")
+        else:
-            )
+            # ! Prompt the user to enter a subreddit
-        except ValueError:
+            try:
-            subreddit = reddit.subreddit("askreddit")
+                subreddit = reddit.subreddit(
-            print_substep("Subreddit not defined. Using AskReddit.")
+                    re.sub(
+                        r"r\/",
+                        "",
+                        input("What subreddit would you like to pull from? "),
+                    )
+                )
+            except ValueError:
+                subreddit = reddit.subreddit("askreddit")
+                print_substep("Subreddit not defined. Using AskReddit.")
+
+        threads = subreddit.hot(limit=25)
+        submission = list(threads)[random.randrange(0, 25)]
 
-    threads = subreddit.hot(limit=25)
-    submission = list(threads)[random.randrange(0, 25)]
     print_substep(f"Video will be: {submission.title} :thumbsup:")
     try:
-
         content["thread_url"] = submission.url
         content["thread_title"] = submission.title
         content["comments"] = []
 
         for top_level_comment in submission.comments:
+<<<<<<< HEAD
             COMMENT_LENGTH_RANGE = [0, Infinity]
             if os.getenv("COMMENT_LENGTH_RANGE"):
                 COMMENT_LENGTH_RANGE = [int(i) for i in os.getenv("COMMENT_LENGTH_RANGE").split(",")]                
             if COMMENT_LENGTH_RANGE[0] <= len(top_level_comment.body) <= COMMENT_LENGTH_RANGE[1]:
+=======
+            if not top_level_comment.stickied:
+>>>>>>> upstream/master
                 content["comments"].append(
                     {
                         "comment_body": top_level_comment.body,

video_creation/final_video.py

@@ -7,14 +7,24 @@ from moviepy.editor import (
     CompositeAudioClip,
     CompositeVideoClip,
 )
+import reddit.subreddit 
+import re
 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 +34,7 @@ def make_final_video(number_of_clips):
         .resize(height=H)
         .crop(x1=1166.6, y1=0, x2=2246.6, y2=1920)
     )
+
     # Gather all audio clips
     audio_clips = []
     for i in range(0, number_of_clips):
@@ -39,23 +50,23 @@ 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")
     )
     image_concat.audio = audio_composite
     final = CompositeVideoClip([background_clip, image_concat])
-    final.write_videofile(
+    filename = (re.sub('[?\"%*:|<>]', '', ("assets/" + reddit.subreddit.submission.title + ".mp4")))
-        "assets/final_video.mp4", fps=30, audio_codec="aac", audio_bitrate="192k"
+    final.write_videofile(filename, fps=30, audio_codec="aac", audio_bitrate="192k")
-    )
-
     for i in range(0, number_of_clips):
         pass