Create a smart document folder cleaner

To create a “smart document folder cleaner,” you would typically develop a tool that uses specific criteria to automatically organize, clean, or delete files from a given folder based on their attributes (e.g., file type, age, size, frequency of use). Here’s a general framework for how to build one:

1. Define Requirements and Features:

• Automatic Organization: Group files into categories (e.g., PDFs, Word Documents, Images, etc.).

• File Age Filtering: Delete or move files older than a certain threshold.

• Duplicate File Detection: Identify and delete duplicate files.

• Size Filtering: Identify large files and either compress or move them.

• User-Defined Rules: Allow users to set custom rules, such as automatically moving files with certain keywords in the name.

• Backup and Restore: Enable automatic backup of files before deletion or movement.

2. Technologies to Use:

• Programming Language: Python (for its extensive file handling libraries).

• Libraries/Modules:

  • os (for file handling)

  • shutil (for file moving and copying)

  • hashlib (for detecting duplicates)

  • datetime (for handling file dates)

  • tkinter or PyQt (for creating a simple graphical user interface if needed)

3. Steps to Build the Cleaner:

Step 1: Scan the Folder

Start by listing all files in the folder.

python
CopyEdit
import os

def scan_folder(folder_path):
    files = []
    for root, dirs, filenames in os.walk(folder_path):
        for file in filenames:
            files.append(os.path.join(root, file))
    return files

Step 2: Sort Files by Type

Organize files based on their extensions (PDF, Word, Images, etc.).

python
CopyEdit
def sort_files_by_type(files):
    file_types = {"pdf": [], "docx": [], "jpg": [], "png": [], "txt": []}
    for file in files:
        ext = file.split('.')[-1].lower()
        if ext in file_types:
            file_types[ext].append(file)
    return file_types

Step 3: Filter by Age

Determine whether a file is older than a certain threshold.

python
CopyEdit
from datetime import datetime, timedelta

def filter_files_by_age(files, age_in_days):
    filtered_files = []
    cutoff_date = datetime.now() - timedelta(days=age_in_days)
    
    for file in files:
        file_mod_time = datetime.fromtimestamp(os.path.getmtime(file))
        if file_mod_time < cutoff_date:
            filtered_files.append(file)
    return filtered_files

Step 4: Identify Duplicates

Detect duplicate files based on their content (hashing).

python
CopyEdit
import hashlib

def find_duplicates(files):
    hashes = {}
    duplicates = []
    
    for file in files:
        with open(file, 'rb') as f:
            file_hash = hashlib.md5(f.read()).hexdigest()
            if file_hash in hashes:
                duplicates.append(file)
            else:
                hashes[file_hash] = file
    return duplicates

Step 5: Delete or Move Files

Delete or move files based on the identified criteria.

python
CopyEdit
import shutil

def move_file(file, destination_folder):
    shutil.move(file, destination_folder)

def delete_file(file):
    os.remove(file)

Step 6: User Interface (Optional)

If you want a graphical interface for the tool, you could use tkinter or PyQt for a simple file picker and options selection.

Here’s a basic UI concept using tkinter:

python
CopyEdit
import tkinter as tk
from tkinter import filedialog

def select_folder():
    folder = filedialog.askdirectory(title="Select Folder")
    if folder:
        print(f"Selected Folder: {folder}")
        return folder

root = tk.Tk()
root.withdraw()  # Hide the main window
folder = select_folder()

4. Putting It All Together

After defining all these functions, you can create a script that automates the entire process. Here’s an example of how it might look:

python
CopyEdit
def clean_folder(folder_path, age_limit, duplicate_check=True):
    print("Scanning folder...")
    files = scan_folder(folder_path)
    
    print("Sorting files by type...")
    sorted_files = sort_files_by_type(files)
    
    print(f"Filtering files older than {age_limit} days...")
    old_files = filter_files_by_age(files, age_limit)
    
    if duplicate_check:
        print("Finding duplicate files...")
        duplicates = find_duplicates(files)
    else:
        duplicates = []
    
    print(f"Deleting old files...")
    for file in old_files:
        delete_file(file)
    
    print(f"Deleting duplicate files...")
    for file in duplicates:
        delete_file(file)

    print("Cleaning complete.")

5. Final Adjustments:

• Backup Option: Before deleting or moving files, add a backup feature.

• Logging: Create logs of all actions taken (deleted/moved files).

• Notifications: Send a notification (email, system popup, etc.) after the cleaning process is complete.

• Scheduling: Use tools like cron (on Linux/macOS) or Task Scheduler (on Windows) to automate the process periodically.

This tool could be further refined with more advanced features, but this framework provides the basic steps to create a smart folder cleaner that scans, sorts, filters, and cleans files based on customizable criteria.