Merge pull request #299 from Stonebanks-js/master

Support Custom Folder Configuration for File Arrangement in "Arrange It"

Author: DhanushNehru

.gitignore

@@ -27,7 +27,6 @@ node_modules/
 creds.js
 
 # Private Files
-*.json
 *.csv
 *.csv.gz
 *.tsv

Arrange It/README.md

@@ -1,18 +1,41 @@
 # Arrange It
 
-With the help of this script, files can be moved automatically to the folder that corresponds to their extension (for example, ".jpg" or ".png" ==> "/Pictures," and ".mp4" ==> "/Videos").
+With the help of this script, files can be moved automatically to the folder that corresponds to their extension (for example, .jpg or .png files go to the /Pictures folder, and .mp4 files go to /Videos).
 
-## How To Run
+## New Feature: Custom Folder Configuration
 
-- Put in Download Folder Or Wherever You want to automatically move the file and Just run
+-Now, you can customize how files are arranged by defining your own folder structure and file extensions using a config.json file. This allows for more flexibility without needing to modify the Python code itself.
+python arrangeit.py
+
+# How To Use the config.json File
+
+1. The config.json file contains the mappings of file extensions to folder names.
+2. You can modify, add, or remove folder categories and file extensions as per your needs.
+
+Example config.json:
+
+{
+  "Programming Files": ["ipynb", "py", "java", "cs", "js"],
+  "Music": ["mp3", "wav", "aac"],
+  "Videos": ["mp4", "mkv", "avi"],
+  "Pictures": ["jpeg", "png", "gif"],
+  "Documents": ["pdf", "docx", "xlsx"]
+}
 
-For CLI
+# How To Run
+
+Put the script and the config.json file in the folder where you want to automatically move the files.
+
+Run the following command from the terminal:
 
-```bash
 python arrangeit.py
 
-<!-- This is a manual change to ensure the file is tracked and updated -->
-```
 
-<!-- Updated README links and corrected typos -->
-<!-- Updated README links and corrected typos -->
+The script will create folders and move files based on the folder-extension mappings in the config.json file.
+
+
+# Benefits
+
+Customizable: Easily modify the config.json file to tailor the organization to your preferences.
+User-Friendly: No need to modify Python code—just update the config.json file.
+Scalable: Works with different folder structures for different use cases.

Arrange It/arrangeit.py

@@ -1,47 +1,42 @@
 from shutil import move
-from os import path
 import os
-
-
-directory = {
-    'Programming Files': set(['ipynb', 'py', 'java', 'cs', 'js', 'vsix', 'jar', 'cc', 'ccc', 'html', 'xml', 'kt']),
-    'Music':  set(['mp3', 'wav', 'wma', 'mpa', 'ram', 'ra', 'aac', 'aif', 'm4a', 'tsa']),
-    'Videos':  set(['mp4', 'webm', 'mkv', 'MPG', 'MP2', 'MPEG', 'MPE', 'MPV', 'OGG', 'M4P', 'M4V', 'WMV', 'MOV', 'QT', 'FLV', 'SWF', 'AVCHD', 'avi', 'mpg', 'mpe', 'mpeg', 'asf', 'wmv', 'mov', 'qt', 'rm']),
-    'Pictures':  set(['jpeg', 'jpg', 'png', 'gif', 'tiff', 'raw', 'webp', 'jfif', 'ico', 'psd', 'svg', 'ai']),
-    'Applications': set(['exe', 'msi', 'deb', 'rpm']),
-    'Compressed': set(['zip', 'rar', 'arj', 'gz', 'sit', 'sitx', 'sea', 'ace', 'bz2', '7z']),
-    'Documents': set(['txt', 'pdf', 'doc', 'xlsx', 'pdf', 'ppt', 'pps', 'docx', 'pptx']),
-    'Other': set([])
-}
-
-
-def create_folders():
-
+import json
+
+# Load folder-extension mappings from config.json
+def load_config(file='config.json'):
+    try:
+        with open(file, 'r') as f:
+            return json.load(f)
+    except FileNotFoundError:
+        print(f"Configuration file {file} not found! Using default settings.")
+        return {}
+
+# Create folders based on config.json
+def create_folders(directory):
     for dir_ in directory:
         try:
             os.mkdir(dir_)
             print(f'{dir_:20} Created')
         except OSError:
             print(f'{dir_:20} Already Exists')
 
-
-def get_folder(ext):
-    
-    for f, ex in directory.items():
-        if ext in ex:
-            return f
+# Determine which folder a file belongs to
+def get_folder(ext, directory):
+    for folder, extensions in directory.items():
+        if ext in extensions:
+            return folder
     return 'Other'
 
-
-def start():
+# Start moving files based on their extensions
+def start(directory):
     for filename in os.listdir():
         if filename != __file__ and filename[0] != '.' and '.' in filename:
             ext = os.path.basename(filename).split('.')[-1]
-            folder = get_folder(ext)
+            folder = get_folder(ext, directory)
             if not os.path.isfile(os.path.join(folder, filename)):
                 move(filename, folder)
 
-
 if __name__ == '__main__':
-    create_folders()
-    start()
+    config = load_config()  # Load configuration
+    create_folders(config)  # Create necessary folders
+    start(config)           # Start organizing files

Arrange It/config.json

@@ -0,0 +1,11 @@
+{
+    "Programming Files": ["ipynb", "py", "java", "cs", "js", "vsix", "jar", "cc", "ccc", "html", "xml", "kt"],
+    "Music": ["mp3", "wav", "wma", "mpa", "ram", "ra", "aac", "aif", "m4a", "tsa"],
+    "Videos": ["mp4", "webm", "mkv", "MPG", "MP2", "MPEG", "MPE", "MPV", "OGG", "M4P", "M4V", "WMV", "MOV", "QT", "FLV", "SWF", "AVCHD", "avi", "mpg", "mpe", "mpeg", "asf", "wmv", "mov", "qt", "rm"],
+    "Pictures": ["jpeg", "jpg", "png", "gif", "tiff", "raw", "webp", "jfif", "ico", "psd", "svg", "ai"],
+    "Applications": ["exe", "msi", "deb", "rpm"],
+    "Compressed": ["zip", "rar", "arj", "gz", "sit", "sitx", "sea", "ace", "bz2", "7z"],
+    "Documents": ["txt", "pdf", "doc", "xlsx", "ppt", "pps", "docx", "pptx"],
+    "Other": []
+  }
+