adding files

Author: mzubairtahir

Google map scraper/images/GMS.png

@@ -0,0 +1,65 @@
+"""
+This module contain the code for saving the scraped data
+"""
+
+
+import pandas as pd
+import os
+
+
+class DataSaver:
+    def __init__(self, selectedpath, outputformat, messageshowfunc) -> None:
+        self.selectedPath = selectedpath
+        self.outputFormat = outputformat
+        self.messageShowFunc = messageshowfunc
+
+    def save(self, datalist):
+        """
+        This function will save the data that has been scrapped.
+        This can be call if any error occurs while scraping , or if scraping is done successfully.
+        In both cases we have to save the scraped data.
+        """
+
+        if len(datalist) > 0:
+            self.messageShowFunc(custom=True, value="Saving the data")
+
+            dataFrame = pd.DataFrame(datalist)
+            totalRecords = dataFrame.shape[0]
+
+            filename = "/gms output"
+
+            if self.outputFormat == "excel":
+                extension = ".xlsx"
+            elif self.outputFormat == "csv":
+                extension = ".csv"
+            elif self.outputFormat == "json":
+                extension = ".json"
+
+            joinedPath = self.selectedPath + filename + extension
+
+            if os.path.exists(joinedPath):
+                index = 1
+                while True:
+                    filename = f"/gms output{index}"
+
+                    joinedPath = self.selectedPath + filename + extension
+
+                    if os.path.exists(joinedPath):
+                        index += 1
+
+                    else:
+                        break
+
+            if self.outputFormat == "excel":
+                dataFrame.to_excel(joinedPath, index=False)
+            elif self.outputFormat == "csv":
+                dataFrame.to_csv(joinedPath, index=False)
+
+            elif self.outputFormat == "json":
+                dataFrame.to_json(joinedPath, indent=4, orient="records")
+
+            self.messageShowFunc(savingdata=True, totalrecords=totalRecords)
+        else:
+            self.messageShowFunc(
+                custom=True, value="Oops! You did not scrape any record..."
+            )

Google map scraper/images/Home.png

@@ -0,0 +1,254 @@
+"""
+This module contain the code for frontend
+"""
+
+
+import tkinter as tk
+from tkinter import ttk, filedialog, WORD
+from scraper import Backend
+import os
+import threading
+import json
+
+
+class Frontend(Backend):
+    def __init__(self):
+        self.settingsPath = self.pathmaker("settings/outputpath.json")
+
+        """Initializing frontend layout"""
+
+        self.root = tk.Tk()
+        icon = tk.PhotoImage(file=self.pathmaker("images/GMS.png"))
+
+        self.root.iconphoto(True, icon)
+        self.root.geometry("850x650")
+        self.root.resizable(False, False)
+        self.root.title("Google maps scraper")
+
+        self.style = ttk.Style()
+        self.style.map(
+            "my.TButton",  # making style for our buttons
+            foreground=[("active", "green")],
+            background=[("active", "white")],
+        )
+
+        bgimage = tk.PhotoImage(file=self.pathmaker("images/Home.png"))
+
+        self.imglabel = tk.Label(self.root, image=bgimage)
+        self.imglabel.place(x=0, y=0, relwidth=1, relheight=1)
+        self.imglabel.image = bgimage
+
+        """For search entry"""
+        self.search_label = ttk.Label(
+            self.root,
+            text="Search:",
+            font=("Franklin Gothic Medium", 17),
+            foreground="green",
+            background="white",
+        )
+        self.search_label.place(x=255, y=175)
+
+        self.search_box = ttk.Entry(self.root, width=30, font=("Arial", 15))
+        self.search_box.place(x=355, y=180)
+
+        """For submit button"""
+        self.submit_button = ttk.Button(
+            self.root,
+            text="Submit",
+            width=15,
+            command=self.getinput,
+            style="my.TButton",
+        )
+        self.submit_button.place(x=355, y=320)
+
+        """for output format entry"""
+        self.outputFormatButtonLabel = ttk.Label(
+            self.root,
+            text="Format:",
+            font=("Franklin Gothic Medium", 17),
+            foreground="green",
+            background="white",
+        )
+        self.outputFormatButtonLabel.place(x=255, y=230)
+
+        self.outputFormatButton = ttk.Combobox(
+            self.root, values=["Excel", "Json", "Csv"], state="readonly"
+        )
+        self.outputFormatButton.place(x=355, y=240)
+
+        """for message box"""
+        self.show_text = tk.Text(
+            self.root,
+            font=("arial", 13),
+            height=10,
+            width=35,
+            state="disabled",
+            border=False,
+            wrap=WORD,
+            highlightbackground="black",
+            highlightthickness=2,
+        )
+        self.show_text.place(x=295, y=440)
+
+        """For reset settings button"""
+        self.resetSettingsButton = ttk.Button(
+            self.root,
+            text="Reset settings",
+            width=15,
+            command=self.resetsettings,
+            style="my.TButton",
+        )
+        self.resetSettingsButton.place(x=20, y=590)
+
+
+        self.__replacingtext(
+            "Welcome to Google Maps Scraper!\n\nLet's start scraping..."
+        )
+
+    def __replacingtext(self, text):
+        """This function will insert the text in text showing box"""
+
+        self.show_text.config(state="normal")
+        # self.messageShowBox.delete(index1=1.0,index2=tkinter.END)
+        self.show_text.insert(tk.END, "• " + text)
+        self.show_text.insert(tk.END, "\n\n")
+        self.show_text.see(tk.END)
+        self.show_text.config(state="disabled")
+
+    def pathmaker(self, relativepath):
+        """Get absolute path to resurce, for deployment of this application
+        using PyInstaller"""
+
+        try:
+            # PyInstaller creates a temp folder and stores path in _MEIPASS
+            base_path = sys._MEIPASS
+        except Exception as p:
+            base_path = os.path.abspath(".")
+
+        return os.path.join(base_path, relativepath)
+
+    def getinput(self):
+        self.searchQuery = self.search_box.get()
+        self.outputFormatValue = self.outputFormatButton.get()
+
+        if len(self.searchQuery) == 0 and len(self.outputFormatValue) == 0:
+            self.__replacingtext(text="Oops! Your query is not valid")
+
+        elif len(self.searchQuery) == 0:
+            self.__replacingtext(text="Oops! You did empty search")
+        elif len(self.outputFormatValue) == 0:
+            self.__replacingtext(text="Oops! You did not select output format")
+
+        else:
+            self.askingfolderpath()
+
+            if len(self.outputfolderpath) == 0:
+                self.__replacingtext(
+                    "You did not select any folder\nKindly submit again and select one folder where files will be stored"
+                )
+            else:
+                self.submit_button.config(state="disabled")
+
+                self.searchQuery = self.searchQuery.lower()
+                self.outputFormatValue = self.outputFormatValue.lower()
+
+                self.threadToStartBackend = threading.Thread(target=self.startscraping)
+                self.threadToStartBackend.start()
+
+    def closingbrowser(self):
+        """It will close the browser when the app is closed"""
+
+        try:
+            super().closeThread.set()
+            self.root.destroy()
+        except:
+            pass
+
+    def startscraping(self):
+        super().__init__(
+            self.searchQuery,
+            self.outputFormatValue,
+            self.messageshowing,
+            self.outputfolderpath,
+        )
+
+        self.mainscraping()
+
+    def messageshowing(
+        self,
+        interruptionerror=False,
+        savingdata=False,
+        totalrecords=None,
+        custom=False,
+        value=None,
+        noresultfound=False,
+    ):
+
+        if interruptionerror:
+            self.__replacingtext("Interruption in browser is absorved")
+            self.submit_button.config(state="normal")
+            try:
+                if self.threadToStartBackend.is_alive():
+                    self.threadToStartBackend.join()
+            except:
+                pass
+
+        elif savingdata:
+            self.__replacingtext(
+                f"Scraped data is saved\nTotal records saved: {totalrecords}"
+            )
+            self.submit_button.config(state="normal")
+            try:
+                if self.threadToStartBackend.is_alive():
+                    self.threadToStartBackend.join()
+            except:
+                pass
+        
+        elif noresultfound:
+            self.submit_button.config(state="normal")
+            try:
+                if self.threadToStartBackend.is_alive():
+                    self.threadToStartBackend.join()
+            except:
+                pass
+
+            self.__replacingtext("We are sorry but, No results found for your search query on googel maps....")
+            
+        elif custom:
+            self.__replacingtext(text=value)
+
+    def askingfolderpath(self):
+        with open(self.settingsPath, "r") as f:
+            self.outputfolderpath = json.load(f)["path"]
+
+        if len(self.outputfolderpath) == 0:
+            self.__replacingtext(
+                "Kindly select a folder where scraped data will be saved"
+            )
+            self.outputfolderpath = filedialog.askdirectory()
+
+            with open(self.settingsPath, "w") as f:
+                json.dump({"path": self.outputfolderpath}, f)
+
+        elif os.path.exists(self.outputfolderpath):
+            pass
+        else:
+            self.__replacingtext(
+                "The folder you selected is no longer present.\nSo select new folder"
+            )
+
+            self.outputfolderpath = filedialog.askdirectory()
+            with open(self.settingsPath, "w") as f:
+                json.dump({"path": self.outputfolderpath}, f)
+
+            self.__replacingtext("")
+
+    def resetsettings(self):
+        with open(self.settingsPath, "w") as f:
+            json.dump({"path": ""}, f)
+
+
+if __name__ == "__main__":
+    app = Frontend()
+    app.root.protocol("WM_DELETE_WINDOW", app.closingbrowser)
+    app.root.mainloop()