Skip to content
GodswillplayPublic

About

High-speed directory flattening desktop utility with 1-click reversible undo, smart multi-select filters, and duplicate protection.

Topics

Resources

Stars

3 stars

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

Repository files navigation

Unfolder

Latest Release GitHub Stars Platform Windows Python Version Standalone Exe License MIT

Unfolder is a clean, modern desktop utility that quickly gathers all files from deeply nested subfolders into a single folder — complete with duplicate file protection, real-time progress, and a 1-click Undo & Restore snapshot.


⚡ Why Unfolder?

Organizing deeply nested files by hand or with terminal commands can be tedious, error-prone, and risky. Unfolder makes the process effortless and safe:

  • Messy Archive Extractions: Zips inside zips, Google Takeout dumps, or nested client downloads.
  • Photography & Media Ingestion: Consolidate SD card dumps (DCIM/100CANON, DCIM/101CANON) into one clean folder.
  • Dataset & ML Preprocessing: Flatten thousands of nested category folders into a unified batch directory for training pipelines.
  • Document Aggregation: Gather invoices and receipts scattered across nested Year/Month/Day subfolders.

🖥️ Intuitive 3-Step Workflow

+---------------------------------------------------------------------------------+
| Unfolder                                                                        |
| Gather all files from nested subfolders into one place — with 1-click Undo.     |
+---------------------------------------------------------------------------------+
|                                                                                 |
|  [ 📁 Client_Assets                                             Change Folder ] |
|    C:\Users\Downloads\Client_Assets                                             |
|                                                                                 |
|  +-----------------+  +-----------------+  +-----------------+  +-------------+ |
|  |       48        |  |        6        |  |        0        |  |   14.2 MB   | |
|  |  FILES TO MOVE  |  | FOLDERS TO CLEAN|  | NAME DUPLICATES |  | TOTAL SIZE  | |
|  +-----------------+  +-----------------+  +-----------------+  +-------------+ |
|                                                                                 |
|  ✓ Safe to flatten: Duplicate filenames automatically receive a (1) suffix.     |
|                                                                                 |
|  [ Flatten Folder Now (48 Files) ]                      [ Open in Explorer ]    |
|                                                                                 |
|  ▶ Advanced Options (Filters & Exclusions)                                      |
|  ▶ View Detailed Activity Log                                                   |
+---------------------------------------------------------------------------------+

🌟 Key Features

1. 🔄 1-Click Reversible Undo

Every flatten cycle automatically saves a lightweight .unfolder_manifest.json in the root folder.

  • If you ever want to revert, Unfolder automatically detects the manifest and shows [ ↩️ Undo & Restore Folders ].
  • One click recreates all original nested folders and returns every file to its exact original place.

2. ⚡ Automatic Duplicate Protection

Never worry about overwriting files with identical names. Unfolder automatically renames duplicates with numbered suffixes (file (1).ext, file (2).ext), keeping all your data intact.

3. 🔍 Instant Smart Summary

The moment you select a folder, Unfolder instantly scans and summarizes:

  • How many files will be moved.
  • How many empty folders will be cleaned up.
  • Exactly how many filename duplicates exist.
  • Total size of the files.

4. 🎯 Multi-Select Categories & Bulk Skip Selectors (Advanced Options)

Expand the Advanced Options drawer to fine-tune exactly what moves and what stays:

  • Multi-Select Include Chips: Click any combination of categories simultaneously (e.g. Images + Docs, or Videos + Audio). Both categories are automatically unioned and flattened together.
  • Category Combinations Dropdown: Quick access to multi-category presets (Images + Documents, Media, Code & Data).
  • Bulk Skip Blacklist Chips: 1-click bulk skipping for + Temp & Logs (.tmp, .bak, .log, .old, .cache), + Archives (.zip, .rar, .7z), + Videos, + Audio, and + Dev Caches.
  • Detected in Current Folder Pickers: Live inventory of every extension found in your subfolders with file counts. Click to add any discovered extension to either the Include or Skip list.
  • Smooth Vertical Scrolling: Built inside a native scrollable container with mouse wheel support so you can easily access every option and log on any screen size.
  • Junk File Cleaner: Automatically ignores and cleans up system clutter (.git, .DS_Store, Thumbs.db, desktop.ini, node_modules).
  • Manual Override: Edit included or excluded extensions directly for custom patterns.

🚀 Quick Start

Option A: Portable Standalone (.exe) — No Python Needed

  1. Download Unfolder.exe from GitHub Releases or directly from dist/Unfolder.exe.
  2. Double-click to launch. Zero setup required.

Option B: Run from Source

Requires Python 3.10+:

# Clone the repository
git clone https://github.com/Godswillplay/unfolder.git
cd unfolder

# Install dependencies
pip install -r requirements.txt

# Run the application
python unfolder.py

Or on Windows, simply double-click run.bat (launches windowless via pythonw).


🛠️ Building the Standalone .exe

To compile the single-file executable:

# Double-click build_exe.bat OR run:
pyinstaller --noconsole --onefile --clean --name "Unfolder" --collect-all customtkinter --add-data "assets;assets" unfolder.py

The compiled binary will be placed in dist\Unfolder.exe.


📁 Repository Structure

unfolder/
├── assets/
│   └── fonts/
│       ├── SpaceGrotesk.ttf   # Headline & metric typography
│       └── Inter.ttf          # Clean label typography
├── dist/
│   └── Unfolder.exe           # Standalone portable Windows executable
├── .gitignore                 # Standard Python & PyInstaller exclusions
├── build_exe.bat              # One-click PyInstaller build script
├── LICENSE                    # MIT License
├── README.md                  # Documentation & user guide
├── requirements.txt           # Python dependencies (customtkinter)
├── run.bat                    # Windows background-free launch script
├── unfolder.py                # Core application engine
└── unfolder.pyw               # Windowless Python launcher

🔒 Safety Guarantees

  • Root Folder Safety: The top folder itself is never moved or deleted.
  • Zero Overwrites: Duplicate names are renamed cleanly with (1), (2).
  • Undoable by Design: A complete snapshot is saved so you can reverse the operation at any time.
  • Non-Blocking Execution: Background threads keep the interface responsive even on folders with 100,000+ files.

📄 License

Distributed under the MIT License. See LICENSE for details.

About

High-speed directory flattening desktop utility with 1-click reversible undo, smart multi-select filters, and duplicate protection.

Topics

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages