Merge branch '1.1' into patch-1

.env.template

@@ -1,4 +1,11 @@
 REDDIT_CLIENT_ID=""
 REDDIT_CLIENT_SECRET=""
 REDDIT_USERNAME=""
-REDDIT_PASSWORD=""
+REDDIT_PASSWORD=""
+
+# Valid options are "yes" and "no" for the variable below
+REDDIT_2FA=""
+
+THEME=""
+
+SUBREDDIT=""

.gitignore

@@ -1,3 +1,4 @@
 assets/
 .env
-reddit-bot-351418-5560ebc49cac.json
+reddit-bot-351418-5560ebc49cac.json
+__pycache__

README.md

@@ -26,26 +26,29 @@ These videos on TikTok, YouTube and Instagram get MILLIONS of views across all p
 ## Requirements
 
 - Python 3.6+
-- Playwright (this should install automatically in installation)
+- Playwright (this should install automatically during installation)
 
 ## Installation 👩‍💻
 
 1. Clone this repository
-2. Rename `.env.template` to `.env` and replace all values with the appropriate fields. To get Reddit keys (**required**), visit [the Reddit Apps page.](https://www.reddit.com/prefs/apps) TL;DR set up an app that is a "script". Copy your keys into the `.env` files.
+2. Rename `.env.template` to `.env` and replace all values with the appropriate fields. To get Reddit keys (**required**), visit [the Reddit Apps page.](https://www.reddit.com/prefs/apps) TL;DR set up an app that is a "script". Copy your keys into the `.env` file, along with whether your account uses two-factor authentication.
 3. Run `pip3 install -r requirements.txt`
-4. Run `python3 -m playwright install`
+4. Run `playwright install` and `playwright install-deps`.
 5. Run `python3 main.py`
-6. ...
+6. Enjoy 😎
-7. Enjoy 😎
+
+
+If you want to see more detailed guide, please refer to the official [documentation](https://immaharry.gitbook.io/reddit-automated-video-bot/).
+*The Documentation is still being developed and worked on, please be patient as we change / add new knowledge!
 
 ## Contributing & Ways to improve 📈
 
 In its current state, this bot does exactly what it needs to do. However, lots of improvements can be made.
 
-I have tried to simplify the code so anyone can read it and start contibuting at any skill level. Don't be shy :) contribute!
+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.
 - [ ] Allowing users to choose a background that is picked instead of the Minecraft one.
-- [ ] Allowing users to choose between any subreddit.
+- [x] Allowing users to choose between any subreddit.
 - [ ] Allowing users to change voice.
 - [ ] Creating better documentation and adding a command line interface.

main.py

@@ -1,22 +1,26 @@
 from utils.console import print_markdown
 import time
-from reddit.askreddit import get_askreddit_threads
+
+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
 
 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."
+    "### 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_askreddit_threads()
+reddit_object = get_subreddit_threads()
 
+load_dotenv()
 length, number_of_comments = save_text_to_mp3(reddit_object)
-download_screenshots_of_reddit_posts(reddit_object, number_of_comments)
+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)

reddit/subreddit.py

@@ -5,24 +5,50 @@ from dotenv import load_dotenv
 import os
 
 
-def get_askreddit_threads():
+def get_subreddit_threads():
+
     """
     Returns a list of threads from the AskReddit subreddit.
     """
 
+    load_dotenv()
+
     print_step("Getting AskReddit threads...")
 
+    if os.getenv("REDDIT_2FA").lower() == "yes":
+        print(
+            "\nEnter your two-factor authentication code from your authenticator app.\n"
+        )
+        code = input("> ")
+        print()
+        pw = os.getenv("REDDIT_PASSWORD")
+        passkey = f"{pw}:{code}"
+    else:
+        passkey = os.getenv("REDDIT_PASSWORD")
+
     content = {}
-    load_dotenv()
+
     reddit = praw.Reddit(
         client_id=os.getenv("REDDIT_CLIENT_ID"),
         client_secret=os.getenv("REDDIT_CLIENT_SECRET"),
         user_agent="Accessing AskReddit threads",
         username=os.getenv("REDDIT_USERNAME"),
-        password=os.getenv("REDDIT_PASSWORD"),
+        password=passkey,
     )
-    askreddit = reddit.subreddit("askreddit")
+
-    threads = askreddit.hot(limit=25)
+    if os.getenv("SUBREDDIT"):
+        subreddit = reddit.subreddit(os.getenv("SUBREDDIT"))
+    else:
+        # ! Prompt the user to enter a subreddit
+        try:
+            subreddit = reddit.subreddit(
+                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)]
     print_substep(f"Video will be: {submission.title} :thumbsup:")
     try:
@@ -42,5 +68,6 @@ def get_askreddit_threads():
 
     except AttributeError as e:
         pass
-    print_substep("Received AskReddit threads Successfully.", style="bold green")
+    print_substep("Received AskReddit threads successfully.", style="bold green")
+
     return content

requirements.txt

@@ -1,42 +1,8 @@
-appdirs==1.4.4
-black==20.8b1
-certifi==2021.10.8
-charset-normalizer==2.0.12
-click==7.1.2
-commonmark==0.9.1
-decorator==4.4.2
-flake8==3.8.3
-greenlet==1.1.2
 gTTS==2.2.4
-idna==3.3
-imageio==2.19.2
-imageio-ffmpeg==0.4.7
-mccabe==0.6.1
 moviepy==1.0.3
 mutagen==1.45.1
-mypy-extensions==0.4.3
-numpy==1.22.3
-pathspec==0.8.0
-Pillow==9.1.1
 playwright==1.22.0
 praw==7.6.0
-prawcore==2.3.0
-proglog==0.1.10
-pycodestyle==2.6.0
-pyee==8.1.0
-pyflakes==2.2.0
-Pygments==2.12.0
 python-dotenv==0.20.0
-pytube==12.1.0
-regex==2020.10.15
-requests==2.27.1
 rich==12.4.4
-six==1.16.0
+yt_dlp==2022.5.18
-toml==0.10.1
-tqdm==4.64.0
-typed-ast==1.4.1
-typing_extensions==4.2.0
-update-checker==0.18.0
-urllib3==1.26.9
-websocket-client==1.3.2
-websockets==10.1

video_creation/background.py

@@ -1,5 +1,7 @@
 from random import randrange
-from pytube import YouTube
+
+from yt_dlp import YoutubeDL
+
 from pathlib import Path
 from moviepy.video.io.ffmpeg_tools import ffmpeg_extract_subclip
 from moviepy.editor import VideoFileClip
@@ -11,7 +13,6 @@ def get_start_and_end_times(video_length, length_of_clip):
     random_time = randrange(180, int(length_of_clip) - int(video_length))
     return random_time, random_time + video_length
 
-
 def download_background():
     """Downloads the background video from youtube.
 
@@ -20,20 +21,24 @@ def download_background():
 
     if not Path("assets/mp4/background.mp4").is_file():
         print_step(
-            "We need to download the Minecraft background video. This is fairly large but it's only done once. 😎"
+            "We need to download the Minecraft background video. This is fairly large but it's only done once."
-        )
-        print_substep("Downloading the background video... please be patient 🙏")
-        YouTube("https://www.youtube.com/watch?v=n_Dv4JMiwK8").streams.filter(
-            res="720p"
-        ).first().download(
-            "assets/mp4",
-            filename="background.mp4",
         )
-        print_substep("Background video downloaded successfully! 🎉", style="bold green")
+
+        print_substep("Downloading the background video... please be patient.")
+
+        ydl_opts = {
+            "outtmpl": "assets/mp4/background.mp4",
+            "merge_output_format": "mp4",
+        }
+
+        with YoutubeDL(ydl_opts) as ydl:
+            ydl.download("https://www.youtube.com/watch?v=n_Dv4JMiwK8")
+
+        print_substep("Background video downloaded successfully!", style="bold green")
 
 
 def chop_background_video(video_length):
-    print_step("Finding a spot in the background video to chop...✂️")
+    print_step("Finding a spot in the background video to chop...")
     background = VideoFileClip("assets/mp4/background.mp4")
 
     start_time, end_time = get_start_and_end_times(video_length, background.duration)
@@ -43,4 +48,4 @@ def chop_background_video(video_length):
         end_time,
         targetname="assets/mp4/clip.mp4",
     )
-    print_substep("Background video chopped successfully! 🎉", style="bold green")
+    print_substep("Background video chopped successfully!", style="bold green")

video_creation/cookies.json

@@ -0,0 +1,8 @@
+[
+  {
+    "name": "USER",
+    "value": "eyJwcmVmcyI6eyJ0b3BDb250ZW50RGlzbWlzc2FsVGltZSI6MCwiZ2xvYmFsVGhlbWUiOiJSRURESVQiLCJuaWdodG1vZGUiOnRydWUsImNvbGxhcHNlZFRyYXlTZWN0aW9ucyI6eyJmYXZvcml0ZXMiOmZhbHNlLCJtdWx0aXMiOmZhbHNlLCJtb2RlcmF0aW5nIjpmYWxzZSwic3Vic2NyaXB0aW9ucyI6ZmFsc2UsInByb2ZpbGVzIjpmYWxzZX0sInRvcENvbnRlbnRUaW1lc0Rpc21pc3NlZCI6MH19",
+    "domain": ".reddit.com",
+    "path": "/"
+  }
+]

video_creation/final_video.py

@@ -14,7 +14,7 @@ W, H = 1080, 1920
 
 
 def make_final_video(number_of_clips):
-    print_step("Creating the final video 🎥")
+    print_step("Creating the final video...")
     VideoFileClip.reW = lambda clip: clip.resize(width=W)
     VideoFileClip.reH = lambda clip: clip.resize(width=H)
 

video_creation/screenshot_downloader.py

@@ -2,9 +2,10 @@ from playwright.sync_api import sync_playwright
 from pathlib import Path
 from rich.progress import track
 from utils.console import print_step, print_substep
+import json
 
 
-def download_screenshots_of_reddit_posts(reddit_object, screenshot_num):
+def download_screenshots_of_reddit_posts(reddit_object, screenshot_num, theme):
     """Downloads screenshots of reddit posts as they are seen on the web.
 
     Args:
@@ -20,15 +21,21 @@ def download_screenshots_of_reddit_posts(reddit_object, screenshot_num):
         print_substep("Launching Headless Browser...")
 
         browser = p.chromium.launch()
+        context = browser.new_context()
+
+        if theme.casefold() == "dark":
+            cookie_file = open('video_creation/cookies.json')
+            cookies = json.load(cookie_file)
+            context.add_cookies(cookies)
 
         # Get the thread screenshot
-        page = browser.new_page()
+        page = context.new_page()
         page.goto(reddit_object["thread_url"])
 
         if page.locator('[data-testid="content-gate"]').is_visible():
             # This means the post is NSFW and requires to click the proceed button.
 
-            print_substep("Post is NSFW. You are spicy... :fire:")
+            print_substep("Post is NSFW. You are spicy...")
             page.locator('[data-testid="content-gate"] button').click()
 
         page.locator('[data-test-id="post-content"]').screenshot(
@@ -50,4 +57,4 @@ def download_screenshots_of_reddit_posts(reddit_object, screenshot_num):
             page.locator(f"#t1_{comment['comment_id']}").screenshot(
                 path=f"assets/png/comment_{idx}.png"
             )
-        print_substep("Screenshots downloaded Successfully.", style="bold green")
+        print_substep("Screenshots downloaded successfully.", style="bold green")

video_creation/voices.py

@@ -11,13 +11,13 @@ def save_text_to_mp3(reddit_obj):
     Args:
         reddit_obj : The reddit object you received from the reddit API in the askreddit.py file.
     """
-    print_step("Saving Text to MP3 files 🎶")
+    print_step("Saving Text to MP3 files...")
     length = 0
 
     # Create a folder for the mp3 files.
     Path("assets/mp3").mkdir(parents=True, exist_ok=True)
 
-    tts = gTTS(text=reddit_obj["thread_title"], lang="en", slow=False, tld="co.uk")
+    tts = gTTS(text=reddit_obj["thread_title"], lang="en", slow=False)
     tts.save(f"assets/mp3/title.mp3")
     length += MP3(f"assets/mp3/title.mp3").info.length
 
@@ -25,10 +25,10 @@ def save_text_to_mp3(reddit_obj):
         # ! 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")
+        tts = gTTS(text=comment["comment_body"], lang="en", slow=False)
         tts.save(f"assets/mp3/{idx}.mp3")
         length += MP3(f"assets/mp3/{idx}.mp3").info.length
 
-    print_substep("Saved Text to MP3 files Successfully.", style="bold green")
+    print_substep("Saved Text to MP3 files successfully.", style="bold green")
     # ! Return the index so we know how many screenshots of comments we need to make.
     return length, idx