Create setup TUI and improve overall UX

.gitignore

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

README.md

@@ -31,10 +31,13 @@ These videos on TikTok, YouTube and Instagram get MILLIONS of views across all p
 ## 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.
-3. Run `pip3 install -r requirements.txt`
-4. Run `python3 main.py`
-5. ...
+2. Run `pip3 install -r requirements.txt`
+3. 
+	3a. **Automatic Setup**: Run `python3 main.py` and type "yes" where it says "Setup Wizard". The Setup Wizard will guide you through the setup process.
+
+	3b. **Manual Setup**: 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.
+
+4. (only if you did manual setup) Run `python3 main.py`
 6. Enjoy 😎
 
 ## Contributing & Ways to improve 📈

main.py

@@ -1,15 +1,61 @@
+# Main
 from utils.console import print_markdown
+from utils.console import print_step
+from utils.console import print_substep
+from rich.console import Console
 import time
+import os
 from reddit.askreddit import get_askreddit_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 utils.loader import Loader
+from dotenv import load_dotenv
+console = Console()
 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."
 )
 
+"""
+
+Load .env file if exists. If it doesnt exist, print a warning and launch the setup wizard.
+If there is a .env file, check if the required variables are set. If not, print a warning and launch the setup wizard.
+
+"""
+
+client_id=os.getenv("REDDIT_CLIENT_ID")
+client_secret=os.getenv("REDDIT_CLIENT_SECRET")
+username=os.getenv("REDDIT_USERNAME")
+password=os.getenv("REDDIT_PASSWORD")
+
+console.log("[bold green]Checking environment variables...")
+time.sleep(1)
+
+if client_id == "" or client_secret == "" or username == "" or password == "":
+
+	console.log("[red]Looks like you need to set your Reddit credentials in the .env file. Please follow the instructions in the README.md file to set them up.")
+	time.sleep(0.5)
+	console.log("[red]We can also launch the easy setup wizard. type yes to launch it, or no to quit the program.")
+	setup_ask = input("Launch setup wizard? > ")
+	if setup_ask=="yes":
+		console.log("[bold green]Here goes nothing! Launching setup wizard...")
+		time.sleep(0.5)
+		os.system("python3 setup.py")
+	else: 
+		if setup_ask=="no":
+			console.print("[red]Exiting...")
+			time.sleep(0.5)
+			exit()
+		else:
+			console.print("[red]I don't understand that. Exiting...")
+			time.sleep(0.5)
+			exit()
+
+
+	exit()
+
+console.log("[bold green]Enviroment Variables are set! Continuing...")
 time.sleep(3)
 
 

reddit/askreddit.py

@@ -1,9 +1,10 @@
+from rich import Console
 from utils.console import print_markdown, print_step, print_substep
 import praw
 import random
 from dotenv import load_dotenv
 import os
-
+console = Console()
 
 def get_askreddit_threads():
     """
@@ -14,6 +15,7 @@ def get_askreddit_threads():
 
     content = {}
     load_dotenv()
+    console.log("Logging in to reddit...")
     reddit = praw.Reddit(
         client_id=os.getenv("REDDIT_CLIENT_ID"),
         client_secret=os.getenv("REDDIT_CLIENT_SECRET"),
@@ -25,6 +27,7 @@ def get_askreddit_threads():
     threads = askreddit.hot(limit=25)
     submission = list(threads)[random.randrange(0, 25)]
     print_substep(f"Video will be: {submission.title} :thumbsup:")
+    console.log("Getting video comments...")
     try:
 
         content["thread_url"] = submission.url
@@ -43,4 +46,4 @@ def get_askreddit_threads():
     except AttributeError as e:
         pass
     print_substep("Received AskReddit threads Successfully.", style="bold green")
-    return content
+    return content

requirements.txt

@@ -34,7 +34,7 @@ rich==12.4.4
 six==1.16.0
 toml==0.10.1
 tqdm==4.64.0
-typed-ast==1.4.1
+typed-ast==1.5.4 # Please see issue https://github.com/elebumm/RedditVideoMakerBot/issues/16 comment three. 
 typing_extensions==4.2.0
 update-checker==0.18.0
 urllib3==1.26.9

setup.py

@@ -0,0 +1,96 @@
+"""
+
+Setup Script for RedditVideoMakerBot
+
+"""
+
+# Imports
+import os
+import time
+from utils.console import print_markdown
+from utils.console import print_step
+from utils.console import print_substep
+from rich.console import Console
+from utils.loader import Loader
+console = Console()
+
+# These lines ensure the user:
+# - knows they are in setup mode
+# - knows that they are about to erase any other setup files/data.
+
+print_step("Setup Assistant")
+
+print_markdown(
+	"### You're in the setup wizard. Ensure you're supposed to be here, then type yes to continue. If you're not sure, type no to quit."
+)
+
+# This Input is used to ensure the user is sure they want to continue.
+ensureSetupIsRequired = input("Are you sure you want to continue? > ")
+if ensureSetupIsRequired != "yes":
+	console.print("[red]Exiting...")
+	time.sleep(0.5)
+	exit()
+else:
+	# Again, let them know they are about to erase all other setup data.
+	console.print("[bold red] This will overwrite your current settings. Are you sure you want to continue? [bold green]yes/no")
+	overwriteSettings = input("Are you sure you want to continue? > ")
+	if overwriteSettings != "yes":
+		console.print("[red]Abort mission! Exiting...")
+		time.sleep(0.5)
+		exit()
+	else:
+		# Once they confirm, move on with the script.
+		console.print("[bold green]Alright! Let's get started!")
+		time.sleep(1)
+
+console.log("Ensure you have the following ready to enter:")
+console.log("[bold green]Reddit Client ID")
+console.log("[bold green]Reddit Client Secret")
+console.log("[bold green]Reddit Username")
+console.log("[bold green]Reddit Password")
+time.sleep(0.5)
+console.print("[green]If you don't have these, please follow the instructions in the README.md file to set them up.")
+console.print("[green]If you do have these, type yes to continue. If you dont, go ahead and grab those quickly and come back.")
+confirmUserHasCredentials = input("Are you sure you have the credentials? > ")
+if confirmUserHasCredentials != "yes":
+	console.print("[red]I don't understand that.")
+	console.print("[red]Exiting...")
+	exit()
+else:
+	console.print("[bold green]Alright! Let's get started!")
+	time.sleep(1)
+
+"""
+
+Begin the setup process.
+
+"""
+
+console.log("Enter your credentials now.")
+cliID = input("Client ID > ")
+cliSec = input("Client Secret > ")
+user = input("Username > ")
+passw = input("Password > ")
+console.log("Attempting to save your credentials...")
+loader = Loader("Saving Credentials...", "Done!").start()
+ # you can also put a while loop here, e.g. while VideoIsBeingMade == True: ...
+time.sleep(0.5)
+console.log("Removing old .env file...")
+os.remove(".env")
+time.sleep(0.5)
+console.log("Creating new .env file...")
+with open('.env', 'a') as f:
+	f.write(f'REDDIT_CLIENT_ID="{cliID}"\n')
+	time.sleep(0.5)
+	f.write(f'REDDIT_CLIENT_SECRET="{cliSec}"\n')
+	time.sleep(0.5)
+	f.write(f'REDDIT_USERNAME="{user}"\n')
+	time.sleep(0.5)
+	f.write(f'REDDIT_PASSWORD="{passw}"\n')
+
+loader.stop()
+
+console.log("[bold green]Setup Complete! Returning...")
+
+# Post-Setup: send message and try to run main.py again.
+os.system("python3 main.py")

utils/loader.py

@@ -0,0 +1,53 @@
+"""
+
+Okay, have to admit. This code is from StackOverflow. It's so efficient, that it's probably the best way to do it.
+Although, it is edited to use less threads.
+
+"""
+from itertools import cycle
+from shutil import get_terminal_size
+from threading import Thread
+from time import sleep
+
+
+class Loader:
+    def __init__(self, desc="Loading...", end="Done!", timeout=0.1):
+        """
+        A loader-like context manager
+
+        Args:
+            desc (str, optional): The loader's description. Defaults to "Loading...".
+            end (str, optional): Final print. Defaults to "Done!".
+            timeout (float, optional): Sleep time between prints. Defaults to 0.1.
+        """
+        self.desc = desc
+        self.end = end
+        self.timeout = timeout
+
+        self._thread = Thread(target=self._animate, daemon=True)
+        self.steps = ["⢿", "⣻", "⣽", "⣾", "⣷", "⣯", "⣟", "⡿"]
+        self.done = False
+
+    def start(self):
+        self._thread.start()
+        return self
+
+    def _animate(self):
+        for c in cycle(self.steps):
+            if self.done:
+                break
+            print(f"\r{self.desc} {c}", flush=True, end="")
+            sleep(self.timeout)
+
+    def __enter__(self):
+        self.start()
+
+    def stop(self):
+        self.done = True
+        cols = get_terminal_size((80, 20)).columns
+        print("\r" + " " * cols, end="", flush=True)
+        print(f"\r{self.end}", flush=True)
+
+    def __exit__(self, exc_type, exc_value, tb):
+        # handle exceptions with those variables ^
+        self.stop()