Merge pull request prathimacode-hub#967 from TusharAMD/CensorWordDetection

prathimacode-hub · web-flow · commit 744b3cf2f193 · 2021-08-05T10:56:49.000+05:30
Censor word detection
diff --git a/GUIScripts/Censor Word Detection/Images/Screenshots/1.png b/GUIScripts/Censor Word Detection/Images/Screenshots/1.png
diff --git a/GUIScripts/Censor Word Detection/Images/Screenshots/2.png b/GUIScripts/Censor Word Detection/Images/Screenshots/2.png
diff --git a/GUIScripts/Censor Word Detection/Images/Screenshots/animation.gif b/GUIScripts/Censor Word Detection/Images/Screenshots/animation.gif
diff --git a/GUIScripts/Censor Word Detection/Images/bg.jpg b/GUIScripts/Censor Word Detection/Images/bg.jpg
diff --git a/GUIScripts/Censor Word Detection/README.md b/GUIScripts/Censor Word Detection/README.md
@@ -0,0 +1,59 @@
+# Censor Word Detection
+
+![Header](https://i.ibb.co/vQkYv2y/header.jpg)
+
+## Aim
+
+In this project I have created a python script that will alert user if he/she has written any censor/abusive/curse word and save that in text file
+
+![Animation](https://github.com/TusharAMD/Awesome_Python_Scripts/blob/CensorWordDetection/GUIScripts/Censor%20Word%20Detection/Images/Screenshots/animation.gif?raw=true)
+![Youtube Link Here](https://youtu.be/O_Osojs7MBY)
+## Purpose
+
+Sometimes we aren't aware of what we are writing and it is possible that in flow we write some abusive words. Such words not only affect our personal image and career but also hurts the person with whom we are having conversation with and it may lead to unnecessary disputes. Therefore using this script the users can keep monitoring themselves so that they won't write any censor words in their text.  
+
+## Short description of package/script
+
+- For GUI Tkinter is used.
+- To work with Images I have used PIL library
+- I am using shortuuid to get unique name for files and also using date time module with that
+- Also using Multiprocessing so that text can be analyzed in real time and data can be saved appropriately
+
+
+## Workflow of the Project
+
+1. As soon as script starts running a GUI is seen in which user has to input the text
+2. I am using a dataset "full list of bad words" to detect censor words
+3. Now this user input is checked with this list and if match is found the text is displayed in screen.
+4. At the same time text matter is saved in text folder which is in Utils\CurseWordsDetected\ folder
+5. Unique name is selected so that we can be assured that files are not overwritten
+6. User can correct mistakes (if any) and then can simply click save button to save text matter
+7. This file is then saved in Utils\InputFile, Naming conventions are same as above
+
+
+
+## Setup instructions
+
+1. Install necessary libraries from requirements.py file
+2. Run censor.py file
+3. Enter text in textbox and correct mistakes if any.
+4. Mistakes can be seen in terminal and all the mistakes are saved in text file also
+5. After satisfactory results click save button to save text and this file can be found in InputFile Folder 
+
+## Compilation Steps
+
+This program using multiprocessing and it runs 2 functions i.e. "sensor" and "guiForCensor" simultaneously.
+As soon as user types in data the text is saved in temp file which is hidden and no use to the user.
+The changes are made there in realtime and same text data is then retrieved to evaluate whether censor words exists or not
+
+\
+## Output
+
+![Img 1](https://raw.githubusercontent.com/TusharAMD/Awesome_Python_Scripts/CensorWordDetection/GUIScripts/Censor%20Word%20Detection/Images/Screenshots/2.png)
+![Img 2](https://raw.githubusercontent.com/TusharAMD/Awesome_Python_Scripts/CensorWordDetection/GUIScripts/Censor%20Word%20Detection/Images/Screenshots/1.png)
+
+## Author(s)
+
+Tushar Amdoskar
+
+[Tushar's Website](https://tusharamd.github.io/)
diff --git a/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWords8Q6qbV6xdif9RWVfBCoLtW.txt b/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWords8Q6qbV6xdif9RWVfBCoLtW.txt
@@ -0,0 +1,6 @@
+ damn
+ godamn
+ ugly
+ shit
+ ho
+ ass
diff --git a/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWordsAvtCjSSjnzCexYREde7yxK.txt b/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWordsAvtCjSSjnzCexYREde7yxK.txt
@@ -0,0 +1,2 @@
+ darkie
+ nigger
diff --git a/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWordsDxwPCt6b2yVQCt4AExyHtp.txt b/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWordsDxwPCt6b2yVQCt4AExyHtp.txt
@@ -0,0 +1,4 @@
+ damn
+ godamn
+ ugly
+ shit
diff --git a/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWordsZkxK6Law8LmVFBSN3YFpkh.txt b/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWordsZkxK6Law8LmVFBSN3YFpkh.txt
@@ -0,0 +1,4 @@
+ damn
+ godamn
+ shit
+ ugly
diff --git a/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWordsdWihdvC3RDRELrbojgM8zH.txt b/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWordsdWihdvC3RDRELrbojgM8zH.txt
@@ -0,0 +1,2 @@
+ damn
+ godamn
diff --git a/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWordsexnGRkZHLbLnGuHrH66Sig.txt b/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWordsexnGRkZHLbLnGuHrH66Sig.txt
@@ -0,0 +1,2 @@
+ damn
+ godamn
diff --git a/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWordsfdegfByXrypvtYjXdf9WoC.txt b/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWordsfdegfByXrypvtYjXdf9WoC.txt
@@ -0,0 +1,3 @@
+ godamn
+ ugly
+ shit
diff --git a/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWordskwgqa54QJCrYYGcwVDWqdU.txt b/GUIScripts/Censor Word Detection/Utils/CurseWordsDetected/detectedWordskwgqa54QJCrYYGcwVDWqdU.txt
@@ -0,0 +1,2 @@
+ fucking
+ kill
diff --git a/GUIScripts/Censor Word Detection/Utils/InputFile/2021-08-05UEW8UedA9qiUFr8fPCeXiu.txt b/GUIScripts/Censor Word Detection/Utils/InputFile/2021-08-05UEW8UedA9qiUFr8fPCeXiu.txt
@@ -0,0 +1 @@
+I think
diff --git a/GUIScripts/Censor Word Detection/Utils/InputFile/2021-08-05bipdMSAzX4ngzpaTE655Nf.txt b/GUIScripts/Censor Word Detection/Utils/InputFile/2021-08-05bipdMSAzX4ngzpaTE655Nf.txt
@@ -0,0 +1,2 @@
+she didn't looked preety in that dress
+oh i forgot to do my practicals
diff --git a/GUIScripts/Censor Word Detection/Utils/InputFile/2021-08-05dg4yVmFepT4uuMU3wCM7Tm.txt b/GUIScripts/Censor Word Detection/Utils/InputFile/2021-08-05dg4yVmFepT4uuMU3wCM7Tm.txt
@@ -0,0 +1,2 @@
+she looked boring in that dress
+oh i forgot to complete practicals
diff --git a/GUIScripts/Censor Word Detection/Utils/InputFile/2021-08-05i9gXKV3fiU57bmHZnPeM6p.txt b/GUIScripts/Censor Word Detection/Utils/InputFile/2021-08-05i9gXKV3fiU57bmHZnPeM6p.txt
@@ -0,0 +1 @@
+abc
diff --git a/GUIScripts/Censor Word Detection/Utils/censor_word_list.txt b/GUIScripts/Censor Word Detection/Utils/censor_word_list.txt
diff --git a/GUIScripts/Censor Word Detection/Utils/tempFile.txt b/GUIScripts/Censor Word Detection/Utils/tempFile.txt
@@ -0,0 +1 @@
+Here you can write any sentence or even paste textIf the paragraph contains curse words the terminal will show that word till its removed. You can save the text using button below after correcting mistakes
diff --git a/GUIScripts/Censor Word Detection/censor.py b/GUIScripts/Censor Word Detection/censor.py
@@ -0,0 +1,121 @@
+import tkinter as tk
+from tkinter import *
+from PIL import Image
+from PIL import ImageTk
+from datetime import date
+import shortuuid
+import multiprocessing
+import time
+
+### This Function is used to detect censor words ###
+def censor(listOfWords):
+    listOfWords=listOfWords.split(",") ## This list contains dataset of curse words
+    #print(" ugly" in listOfWords)
+    li=[]  # In this list we are putting the detected words so that there won't be any repetitions 
+    filename = "Utils/CurseWordsDetected/detectedWords"+str(shortuuid.uuid())+".txt" #For unique name
+    while True:
+        f = open("Utils/tempFile.txt","r")
+        userInput=f.read()
+        userInput=userInput.replace(".", " ")
+        userInput=userInput.replace(",", " ")
+        userInput=userInput.replace("/", " ")
+        userInputList=userInput.split( )
+        #Removing fullstops and commas which can be problematic later
+        
+        #userInput=userInput.split(" ")
+        #print(userInput)
+        
+        # Traversing the dataset and checking if any match is found or not
+        for ele in listOfWords:
+            #for eleUserinp in userInput:
+            #print(eleUserinp,"INPUT") if str(ele).strip() in str(eleUserinp).strip():
+            
+            if str(ele).strip() in str(userInput):
+                ## Now match is found but there is possibility of false alert eg. in homework there is word ho, so it will be false positive so removing that
+                
+                if len(str(ele).strip().split(" "))<2 and str(ele).strip() not in userInputList:
+                    continue
+                    #print("Less than 2",len(str(ele).strip().split(" ")))
+                    #print("False Alert")
+                #else:
+                    #print(len(str(ele).strip().split(" ")))
+                    #pass
+                
+                # Print on terminal detected word
+                print(ele,"detected")
+                
+                
+                # Save in text file
+                f = open(filename,"a+")
+                
+                if ele not in li:
+                    li.append(ele)
+                    ele=ele+"\n"
+                    f.write(ele)
+                
+                time.sleep(1)
+            else:
+                #print(ele,userInput)
+                continue
+
+## This function creates GUI for detector
+
+def guiForCensor():
+    
+    # This function is for saving written input by the user to the file after clicking save button
+    def saveToFile():
+    
+        nameOfFile = 'Utils/InputFile/'+str(date.today())+str(shortuuid.uuid())+'.txt'
+        inputTextMatter=inputtxt.get(1.0,"end-1c")
+        f = open(nameOfFile, "w+")
+        f.write(str(inputTextMatter))
+        print(">> saveFunction")
+        
+    # This is for backend purpose, we are saving file in temp so we can get it later    
+    def printInput():
+        inputTextMatter=inputtxt.get(1.0,"end-1c")
+        f = open("Utils/tempFile.txt", "w+")
+        f.write(str(inputTextMatter))
+        frame.after(2000, printInput)
+        
+    # Creating Frame    
+    frame = tk.Tk()
+    frame.title("Censor Words")
+    frame.geometry('640x480')
+    
+    # Setting Background and necessary components
+    bg="Images/bg.jpg"
+    image=Image.open(bg)
+    image = image.resize((640,480), Image.ANTIALIAS)
+    bg = ImageTk.PhotoImage(image)
+    
+    bglabel=Label(frame,image=bg)
+    bglabel.place(x=0,y=0)
+    
+    inputtxt = tk.Text(frame, height = 15,width = 50)
+    inputtxt.place(x=120,y=100)
+    
+    heading = tk.Label(frame, text="Censor Words", font=("Gentium Basic", 25), bg='#255543', fg='#fff')
+    heading.place(x=220,y=50)
+    
+    saveButton = tk.Button(frame,text="Save",command=saveToFile)
+    saveButton.place(x=315,y=400)
+    
+    frame.after(2000, printInput)
+    frame.mainloop()
+
+# opening dataset    
+f = open("Utils/censor_word_list.txt", "r")
+listOfWords = f.read()    
+
+# Use of multiprocessing to run both functions at same time
+p1 = multiprocessing.Process(target=censor,args=(listOfWords,))
+p2 = multiprocessing.Process(target=guiForCensor)    
+if __name__ == "__main__":
+    p1.start()
+    p2.start()
+    #censor(listOfWords)
+    #guiForCensor()
+    
+    
+    
diff --git a/GUIScripts/Censor Word Detection/requirements.txt b/GUIScripts/Censor Word Detection/requirements.txt
@@ -0,0 +1,2 @@
+shortuuid==1.0.1
+Pillow==8.3.1

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 + damn
 + godamn
 + ugly
 + shit
 + ho
 + ass