Merge pull request #801 from mgndolan/main

Python3 GUI for youtube-dl

Author: pawangeek

youtube_dl_gui/README.md

@@ -0,0 +1,48 @@
+# Youtube Downloader Python3 GUI
+
+This application displays a pop-up GUI for the Youtube Downloader tool using Tkinter. Tkinter is a Python module used to create cross-platform GUIs. This application can download YouTube videos in different resolutions, with captions (if available). For more information about the Youtube Downloader tool itself, see the README.md file in the youtube_downloader folder.
+
+## Setup
+
+For Unix based systems please execute the following command to create venv and install requirements :
+
+```bash
+make init
+source .venv/bin/activate
+```
+
+Install all of the necessary dependencies, such as:
+```
+pip install pytube
+```
+
+## How it works:
+1. Run the script `YoutubeDL.py` by typing either:
+    ```bash
+    python3 YoutubeDL.py
+    ```
+    or
+    ```bash
+    python YoutubeDL.py
+    ```
+2. A window will pop up that looks like the following screen:
+
+![Mac display of Youtube Downloader application](./images/YTDL.png)
+
+Enter in the URL of a YouTube video, as well as the local path to wherever you would like
+the video saved to. The directory path is an optional field, although it will download the
+video to the current directory if no other path is specified.
+
+3. Click on the "Download Video" button. The video may take awhile to download. The button will
+update status to display "Downloading... Please Wait" while `ytdownloader.py` is executing (see image
+below). Once the video is finished downloading, the button text will return to normal.
+
+![Mac display of Youtube Downloader - downloading video](./images/YTDL_download.png)
+
+
+4. To download another video, type in another URL and repeat the process.
+
+## Author(s)
+
+Megan Dolan @mgndolan
+(GUI for work done on youtube_downloader)

youtube_dl_gui/YoutubeDL.py

@@ -0,0 +1,93 @@
+import os
+from time import sleep
+import tkinter as tk
+from PIL import Image, ImageTk
+from threading import Thread
+
+# initialize tkinter GUI
+root = tk.Tk()
+root.title("YouTube Downloader")
+
+# Global variables to save YT Downloader parameters
+ytParams = ""
+
+canvas = tk.Canvas(root, width=650, height=120)
+canvas.grid(columnspan=3, rowspan=5)
+
+# YouTube Downloader - title
+label = tk.Label(root, text="YouTube Downloader")
+label.grid(columnspan=3, row=0, pady=30)
+label.configure(font=("Courier", 28, "bold"))
+
+img = Image.open('images/youtube-logo.png')
+img = ImageTk.PhotoImage(img)
+img_label = tk.Label(image=img)
+img_label.image = img
+img_label.grid(columnspan=3, row=1)
+
+descTxt = "Download your favorite YouTube videos by entering a URL below."
+# Brief tool explanation
+desc = tk.Label(root, text=descTxt)
+desc.grid(columnspan=3, row=2, pady=10)
+desc.configure(font=("Courier", 14))
+
+# Prompts the user to enter a YouTube URL
+urlLabel = tk.Label(text="YouTube URL:")
+urlLabel.grid(column=0, row=3, pady=20)
+urlLabel.configure(font=("Courier", 16))
+
+urlEntry = tk.Entry(root, width=45, borderwidth=2)
+urlEntry.grid(column=1, row=3, pady=20)
+
+# Prompts the user to enter a download path if necessary
+pathLabel = tk.Label(text="Download Path:")
+pathLabel.grid(column=0, row=4, pady=20)
+pathLabel.configure(font=("Courier", 16))
+
+pathEntry = tk.Entry(root, width=45, borderwidth=2)
+pathEntry.grid(column=1, row=4, pady=20)
+
+downloadButton = tk.StringVar()
+downloadButton.set("Download Video")
+
+
+# Function to alert user that the video is downloading.
+class first(Thread):
+    def run(self):
+        downloadButton.set("Downloading... Please Wait")
+        sleep(2)
+
+
+# Function to run youtube_downloader python script.
+class second(Thread):
+    def run(self):
+        command = "python ../youtube_downloader/ytdownloader.py "
+        url = urlEntry.get()
+        ytPath = ""
+
+        path = pathEntry.get()
+        if path:
+            ytPath = " -p " + path
+
+        if not ytPath:
+            runPy = command + " " + url
+        else:
+            runPy = command + " " + url + ytPath
+        os.system(runPy)
+
+        downloadButton.set("Download Video")
+
+
+# Call each function so the class values execute in order.
+def downloadVideo():
+    first().start()
+    second().start()
+
+
+getVideo = tk.Button(root, textvariable=downloadButton,
+                     fg="red", command=downloadVideo,
+                     font=("Courier", 15), height=2)
+getVideo.grid(columnspan=3, row=6, pady=10)
+
+
+root.mainloop()

youtube_dl_gui/images/YTDL.png

@@ -0,0 +1,5 @@
+tkinter
+requests
+pkg-resources==0.0.0
+pytube3==9.6.4
+typing-extensions==3.7.4.3