Directory Organizer

build/lib/directory_organizer.py

@@ -0,0 +1,52 @@
+# Importing Class
+from oopsImplementation import directoryOrganizer
+
+# Importing Libraries
+import time
+
+
+# Package Class
+class organizer:
+
+    # Constructor
+    def __init__(self, path = None, verbose = False):
+
+        # Initialising Class Variables
+
+        self.path = path
+        self.verbose = verbose
+        self.moveFilesObject = None  # Class Object
+
+        # Using Error Handling Techniques to Handle Error(s)
+
+        try:
+            start = time.time()
+            self.moveFilesObject = directoryOrganizer(self.path, self.verbose)
+            self.moveFilesObject.checkCondition()
+            end = time.time()
+            print('Time Elapsed : ', round(end - start, 2), 'seconds')
+
+        except Exception as exception:
+
+            print("Please Try Again! An Unexpected Error has Occurred!")
+            print(f"Type : {type(exception)}")
+            print(f"Error : {exception}")
+
+    # Method to Get Moved Files History
+    def showHistory(self, extension_type = None):
+
+        return self.moveFilesObject.showHistory(extension_type)
+
+
+# Commenting out for Packaging.
+
+
+# Main Method
+if __name__ == '__main__':
+    #path = 'C:\Personal\Work\Directory Organizer\Test\Random'
+    #classObject = organizer(path, True)
+    organizer('C:\\Users\\rahul.bordoloi\\Desktop\\123')
+    #print(classObject.showHistory('Others'))
+
+
+

build/lib/oopsImplementation.py

@@ -0,0 +1,199 @@
+# Importing Libraries
+
+import shutil
+from pathlib import Path
+import os
+from os import listdir
+from os.path import isfile, join
+
+# Class `Directory Organizer`
+class directoryOrganizer:
+
+    # Constructor
+    def __init__(self, path = None, verbose = False):
+
+        # Checking Condition for Default Argument
+        if not path:
+
+            path = "Downloads"
+
+            # Setting Home Directory Path
+            self.homedir = str(Path.home())
+
+            # Set the Source Directory Path [i.e the Downloads Path by DEFAULT]
+            self.source = os.path.join(self.homedir, path)
+
+        else:
+
+            # Set the Source Directory Path [when Path isn't Downloads]
+            self.source = os.path.join(path)
+
+        # Copying All Files Names Present in the Source Directory
+        self.all_files = [files for files in listdir(self.source) if isfile(join(self.source, files))]
+
+        ## NOTE - We can change the "/Downloads" path to any other appropriate path if this script is required to run in that Directory
+
+        # List Containing the files to be Moved
+        self.documents = []
+        self.pictures = []
+        self.musics = []
+        self.videos = []
+        self.others = []
+
+        # Including All Types of File Extensions Possible
+
+        ## Adding file extensions in required places to include that files in that directory
+        self.picture_ext = ['.jpeg', '.jpg', '.png', '.bnp', '.tiff', '.gif', '.raw', '.eps', '.bmp', '.nef']
+        self.document_ext = ['.txt', '.md', '.pdf', '.doc', '.odt', '.docx', '.xls', '.xlsx', '.csv', '.tex', '.ppt', '.pptx', '.rtf', '.wpd']
+        self.music_ext = ['.mp3', '.mpeg', '.wav', '.wma', '.3gp', '.aac', '.wma']
+        self.video_ext = ['.mp4', '.avi', '.mkv', '.mov', '.flv']
+
+        ## Adding CAPS Extensions too
+        self.picture_ext += [i.upper() for i in self.picture_ext]
+        self.document_ext += [i.upper() for i in self.picture_ext]
+        self.music_ext += [i.upper() for i in self.music_ext]
+        self.video_ext += [i.upper() for i in self.video_ext]
+
+        # Flag if the User wants to Print the Output into the Console [Files that are been moved & its Status]
+        self.flag = verbose
+
+        # Dictionary to Keep Track of the Files Moved according to their Type
+        self.historyDictionary = {}
+
+        # Extracting Information about the Files Present
+        self.extractingFiles()
+
+
+    # Method which extracts Information about the Files Present
+
+    def extractingFiles(self):
+
+        # Searching for Files and Categorising
+        for files in self.all_files:
+
+            if files.endswith(tuple(self.picture_ext)):
+                self.pictures.append(files)
+            elif files.endswith(tuple(self.document_ext)):
+                self.documents.append(files)
+            elif files.endswith(tuple(self.music_ext)):
+                self.musics.append(files)
+            elif files.endswith(tuple(self.video_ext)):
+                self.videos.append(files)
+            else:
+                self.others.append(files)
+
+
+    # Display Method to Print Operation(s) [Show Moved Files] [Verbose]
+
+    def printMovedFiles(self, datatype = 'Others'):
+
+        # Initialising List of Files Items & Setting up their Type
+        fileList = None
+
+        if datatype == 'Documents':
+            fileList = self.documents
+        if datatype == 'Pictures':
+            fileList = self.pictures
+        if datatype == 'Musics':
+            fileList = self.musics
+        if datatype == 'Videos':
+            fileList = self.videos
+        elif datatype == 'Others':
+            fileList = self.others
+
+        # Prints the Output to the Console if `verbose` is True
+        if self.flag:
+            print(f'{len(fileList)} Files moved to {datatype}!')
+            for file in fileList:
+                print(file)
+
+
+    # Method Handling the Moving Mechanism
+
+    def moveFilesToDir(self, datatype = 'Others'):
+
+        # Setting up Destination Directory according to Extension Type for Transfer
+        destination = os.path.join(self.source, datatype)
+        self.checkDirExists(destination)
+
+        # File Move Initiation
+        print(f"Moving {datatype[:-1]} File Extensions ...")
+
+        # Initialising List of Files Items & Setting up their Type
+        fileList = None
+
+        if datatype == 'Documents':
+            fileList = self.documents
+        if datatype == 'Pictures':
+            fileList = self.pictures
+        if datatype == 'Musics':
+            fileList = self.musics
+        if datatype == 'Videos':
+            fileList = self.videos
+        elif datatype == 'Others':
+            fileList = self.others
+
+        # Moving the Files from Source to Destination
+        for file in fileList:
+            shutil.move(os.path.join(self.source, file), os.path.join(destination, file))
+
+        # Print Moved Files into the Console if `verbose` is True
+        if self.flag:
+            self.printMovedFiles(datatype)
+
+
+    # Method to Check if Required Files are Present [for Moving] and calling Appropriate Functions accordingly
+
+    def checkCondition(self):
+
+        ## Check for whether the files exists for a Particular Category type or Not
+
+        if len(self.documents) != 0:
+            self.moveFilesToDir('Documents')
+        else:
+            print("No Documents to Move!")
+
+        if len(self.pictures) != 0:
+            self.moveFilesToDir('Pictures')
+        else:
+            print("No Pictures to Move!")
+
+        if len(self.musics) != 0:
+            self.moveFilesToDir('Musics')
+        else:
+            print("No Music Files to Move!")
+
+        if len(self.videos) != 0:
+            self.moveFilesToDir('Videos')
+        else:
+            print("No Videos to Move!")
+
+        if len(self.others) != 0:
+            self.moveFilesToDir('Others')
+        else:
+            print("No Miscellaneous Files to Move!")
+
+
+    # Method to check for Existence of a Directory [if it DNE, creates a New One]
+
+    def checkDirExists(self, path):
+
+        if not os.path.isdir(path):
+            os.makedirs(path)
+
+
+    # Method for Giving out the Dictionary of the Files Being Moved [History]
+
+    def showHistory(self, extension_type = None):
+
+        self.historyDictionary['Documents'] = self.documents
+        self.historyDictionary['Pictures'] = self.pictures
+        self.historyDictionary['Musics'] = self.musics
+        self.historyDictionary['Videos'] = self.videos
+        self.historyDictionary['Others'] = self.others
+
+        if extension_type:
+            return self.historyDictionary[extension_type]
+        else:
+            return self.historyDictionary
+