Merge pull request #768 from Mansi-Binjola/issue-647-creating-tkinter-song-scraper-GUI

Added song_scraper_GUI file

Author: pawangeek

song_scraper_GUI/README.md

@@ -0,0 +1,42 @@
+# Find My Tune
+Find My Tune is a GUI that helps you find and download your favorite songs.
+
+## Requirements
+```
+python3
+pip3
+Tkinter
+selenium chrome driver
+Selenium
+```
+
+## Instruction For Use
+1. run requirements.txt
+
+    `pip3 -r install requirements.txt`
+
+2. run the `findMyTune.py` file using the command
+
+    `python3 findMyTune.py`
+3. Find my Tune is opened, on the search box enter your song name with artist name<sup>1</sup>.
+    ![start window image](./screenshots/open_window_screenshot.png)
+4. Searching the song may take some time, so be patient.
+    ![search window image](./screenshots/search_song_download_screenshot.png)
+5. After the results are shown select any one of the results using the cursor.
+    ![search window image](./screenshots/search_song_download_screenshot.png)
+6. Click on the download button and wait for the results.
+7. Voila! your song is download and is saved inside the downloads folder.
+    ![song downloaded image](./screenshots/song_downloaded_screenshot.png)
+8. Use the refresh button to clear the results.
+9. Steps to use the application and notes are provided in the help window.
+    ![help window image](./screenshots/help_window_screenshot.png)
+
+### AUTHOR
+Code written by [Mansi Binjola](https://linktr.ee/MansiBinjola)
+
+### DISCLAIMER
+1.  Make sure there is no spelling mistake in your search, as sometimes it doesn't find the song correctly. 
+2. There are chances that the song may not be downloaded, so please restart the interface.
+3. The song scraper that I have made can only download a file that is less than 5 min. If you want to download a file that is of big size, simply comment line number 69 of `mp3Clan_top_web_scraper.py`.
+
+    `driver.set_page_load_timeout(20)`

song_scraper_GUI/findMyTune.py

@@ -0,0 +1,218 @@
+from tkinter import Tk, Button, Toplevel, Label, Frame, PhotoImage, Entry
+from tkinter import TOP, LEFT, RIGHT, NE, W, DISABLED, NORMAL, YES
+from tkinter import CENTER, BOTH
+from tkinter import ttk
+import tkinter.messagebox
+import os
+from mp3Clan_top_web_scraper import findMySong, downloadMySong
+
+
+class SongGUI:
+    def __init__(self, root):
+        self.root = root
+        self.root.title('Find my tune')
+        self.root.geometry()
+        self.root.minsize(800, 800)
+        self.searchname = tkinter.StringVar()
+
+        # creating help button
+        help_button_img = PhotoImage(file='images/help_button.png')
+        help_button_img = help_button_img.subsample(2)
+        help_img_label = Label(image=help_button_img)
+        help_img_label.image = help_button_img
+        self.help_button = Button(self.root,
+                                  image=help_button_img,
+                                  command=self.helpFrame,
+                                  border=0)
+        self.help_button.pack(side=TOP, anchor=NE, padx=10, pady=10)
+
+        # creating input frame
+        self.input_frame = Frame(self.root)
+        self.input_frame.pack()
+
+        # creating heading
+        heading = Label(self.input_frame, text="Find My Tune",
+                        font=("Helvetica", 30), fg="black")
+        heading.pack(pady=20, side=TOP)
+
+        # creating search bar
+        self.search_box_input = Entry(self.input_frame, font=(
+            "Helvetica", 20), textvariable=self.searchname)
+        self.search_box_input.pack()
+
+        # creating search button
+        search_button_img = PhotoImage(file='images/search_button.png')
+        search_button_img = search_button_img.subsample(2)
+        search_img_label = Label(image=search_button_img)
+        search_img_label.image = search_button_img
+        self.search_button = Button(self.input_frame, image=search_button_img,
+                                    border=0, command=self.searchSong)
+        self.search_button.pack(pady=10, side=LEFT)
+
+        # creating refresh button
+        refresh_button_img = PhotoImage(file='images/refresh_button.png')
+        refresh_button_img = refresh_button_img.subsample(2)
+        refresh_img_label = Label(image=refresh_button_img)
+        refresh_img_label.image = refresh_button_img
+        self.refresh_button = Button(self.input_frame,
+                                     image=refresh_button_img,
+                                     fg='green',
+                                     command=self.refreshFrame,
+                                     border=0)
+        self.refresh_button.pack(pady=10, side=RIGHT)
+
+    def helpFrame(self):
+        '''shows help Window in new frame'''
+
+        self.help_button['state'] = DISABLED
+        # Toplevel object which will be treated as a new window
+        self.help_window = Toplevel(self.root)
+
+        # sets the title of the Toplevel widget
+        self.help_window.title("Help Window")
+
+        # sets the geometry of toplevel
+        self.help_window.geometry("550x800")
+
+        # making help_window unresizable
+        self.help_window.resizable(0, 0)
+
+        # reading content from help_window.txt
+        info_file = open("help_window.txt")
+        lines = info_file. readlines()
+
+        heading = Label(self.help_window, font=(
+            "Helvetica 20 underline"), text="HELP WINDOW")
+        heading.pack(side=TOP, padx=10, pady=10)
+
+        # code, to show content in help_window
+        Label(self.help_window, wraplength=500, justify="left", font=("", 12),
+              text=lines[0]).pack(side=TOP, pady=10, padx=5)
+        Label(self.help_window, font=("Helvetica 16 underline bold"),
+              text="INSTRUCTIONS").pack(anchor=W, padx=10, pady=10)
+
+        for i in range(1, 9):
+            Label(self.help_window, wraplength=500,
+                  justify="left", font=("", 12),
+                  text=str(i) + ". " + lines[i]).pack(anchor=W, pady=2, padx=10)
+        Label(self.help_window, font=("Helvetica 16 underline"),
+              text="NOTE").pack(anchor=W, padx=10, pady=10)
+        for i in range(8, 11):
+            Label(self.help_window, wraplength=500,
+                  justify="left", font=("", 12),
+                  text=str(i - 7) + ". " + lines[i]).pack(anchor=W, pady=2, padx=10)
+
+        self.help_window.protocol("WM_DELETE_WINDOW", self.close_window)
+
+    def close_window(self):
+        '''function which closes the help_window'''
+        self.help_window.destroy()
+        self.help_button['state'] = NORMAL
+
+    def searchSong(self):
+        ''''function reads the search_input and searchs for the song'''
+        self.songname = self.searchname.get()
+        self.searchname.set('')
+
+        # if the search box is not empty
+        if(self.songname):
+
+            self.songlist = findMySong(self.songname)
+            self.search_button['state'] = DISABLED
+            self.searchname.set('')
+            self.result_frame = Frame(self.root)
+            self.result_frame.pack()
+            self.results = ttk.Treeview(self.result_frame)
+
+            # if search is not empty
+            if(self.songlist):
+
+                # creates four cols, 1 phantom columns
+                self.results['columns'] = ('S.NO', 'Name', 'Duration')
+
+                style = ttk.Style()
+                style.configure("Treeview", rowheight=18, columns=30000)
+
+                self.results.column("#0", stretch=YES, width=0, minwidth=0)
+                self.results.column("S.NO", stretch=YES, anchor=W, width=40)
+                self.results.column("Name", anchor=W, stretch=YES, width=600)
+                self.results.column(
+                    "Duration", stretch=YES, anchor=W, width=80)
+
+                # Create Headings
+                self.results.heading("S.NO", text="S.NO", anchor=W)
+                self.results.heading("Name", text="Name", anchor=CENTER)
+                self.results.heading("Duration", text="Duration", anchor=W)
+
+                self.results.pack(pady=10, expand=1, fill=BOTH)
+                for i in range(len(self.songlist)):
+                    self.results.insert(parent='', index='end', iid=i, text='',
+                                        values=(str(i + 1),
+                                                self.songlist[i]['title'],
+                                                self.songlist[i]['duration']))
+
+                self.down_button = Button(
+                    self.result_frame, text='DOWNLOAD',
+                    fg='white', bg='green',
+                    command=self.downloadSong)
+                self.down_button.pack(padx=10, side=TOP)
+
+            else:
+                tkinter.messagebox.showerror(
+                    'No Song Foumd',
+                    "Could'nt find your song, please try again")
+                self.search_button['state'] = NORMAL
+
+        else:
+            tkinter.messagebox.showerror(
+                'Search box Empty', "Please enter song name")
+            self.search_button['state'] = NORMAL
+
+    def downloadSong(self):
+        '''Function which download the song'''
+
+        self.down_button['state'] = DISABLED
+        songNumber = self.results.focus()
+
+        # if option is selected
+        if(songNumber):
+            songNumber = int(songNumber)
+            downloadMySong(self.songlist[songNumber]['download-link'])
+            filename = [f for f in os.listdir() if f.endswith('.mp3')]
+            if(filename):
+                # rename file and save in download folder
+                os.rename(filename[0], 'downloads/' + filename[0][:-14] + ".mp3")
+                tkinter.messagebox.showinfo(
+                    'Song Downloaded Successfully',
+                    "Your song is downloaded.")
+            else:
+                tkinter.messagebox.showerror(
+                    'Song Not Downloaded',
+                    "Could'nt download your song, please try again later.")
+                filename = [f for f in os.listdir(
+                ) if f.endswith('.crdownload')]
+                if(filename):
+                    for file in filename:
+                        os.remove(file)
+        else:
+            tkinter.messagebox.showerror(
+                'Song Not Selected',
+                "Please choose one item from list, then press download button")
+        self.down_button['state'] = NORMAL
+
+    def refreshFrame(self):
+        '''clears the search window'''
+        self.search_button['state'] = NORMAL
+        self.searchname.set('')
+        try:
+            self.result_frame. pack_forget()
+        except AttributeError:
+            tkinter.messagebox.showinfo(
+                'Already Refreshed',
+                "window already refreshed")
+
+
+if(__name__ == "__main__"):
+    root = Tk()
+    SongGUI(root)
+    root.mainloop()

song_scraper_GUI/help_window.txt

@@ -0,0 +1,12 @@
+Find My Tune is a GUI that helps you find and download your favorite songs.
+To search for your song, write the song name and artist name in the search bar and click on the search button (green button).
+Wait some time, since searching songs some takes time.
+Now select the song which you want to download.
+Now, below will be given a download button. Click it.
+If the window is frozen, wait a minute. Since downloading a file takes time.
+A pop-up will appear if the song is download or not. 
+Congrats, your favorite song is downloaded and safely saved inside the downloads folder.
+Use refresh button to refresh/clear the window.
+For better search results, enter the name of the song, then the name of the artist.
+If the application is frozen or not searching or not downloading after multiple attempts, kindly restart the application.
+This application works better for downloading songs that are of time 5 min or lesser.

song_scraper_GUI/images/help_button.png

@@ -0,0 +1,79 @@
+from selenium import webdriver
+from webdriver_manager.chrome import ChromeDriverManager
+from selenium.common.exceptions import NoSuchElementException, TimeoutException
+import time
+from selenium.webdriver.chrome.options import Options
+
+
+def findMySong(song_name):
+    '''
+        function which accepts string and returns list of 10 available songs
+    '''
+    options = Options()
+    options.headless = True
+
+    driver = webdriver.Chrome(ChromeDriverManager().install(), options=options)
+    driver.get("http://mp3clan.top/mp3/")
+
+    search_box = driver.find_elements_by_xpath('.//*[@id="search-orange"]')
+    search_box[0].send_keys(song_name)
+    search_box[0].click()
+
+    button = driver.find_element_by_class_name("searchClan-button-left")
+    button.click()
+
+    time.sleep(10)
+
+    try:
+        songs = driver.find_elements_by_class_name('mp3list-table')
+        song_list = []
+        cnt = 0
+        for song in songs:
+            try:
+                if(cnt < 10):
+                    details = song.find_element_by_class_name(
+                        "mp3list-play").text
+                    details = details.split("\n")
+                    link_sel_obj = song.find_element_by_tag_name("a")
+                    link = link_sel_obj.get_attribute("href")
+                    link = link[:33] + "get" + link[37:]
+                    if(len(details) > 2):
+                        vid_item = {
+                            'title': details[0],
+                            "duration": details[-1],
+                            "download-link": link
+                        }
+                        song_list.append(vid_item)
+                        cnt += 1
+                else:
+                    break
+            except NoSuchElementException:
+                print("no files found")
+                continue
+    except NoSuchElementException:
+        print("big error")
+    driver.close()
+    return(song_list)
+
+
+def downloadMySong(url):
+    '''
+        function which accepts url,
+        and download's and save song in current directory
+    '''
+    try:
+        options = Options()
+        options.headless = True
+
+        driver = webdriver.Chrome(
+            ChromeDriverManager().install(), options=options)
+        driver.set_page_load_timeout(20)
+
+        driver.get(url)
+        driver.get(url)
+
+        time.sleep(10)
+        driver.close()
+    except TimeoutException:
+        print("session timeout")
+        driver.close()

song_scraper_GUI/images/refresh_button.png

@@ -0,0 +1,2 @@
+selenium
+tk