Skip to content

README.md

Latest commit

 

History

History
93 lines (71 loc) · 2.35 KB

README.md

File metadata and controls

93 lines (71 loc) · 2.35 KB

Smart File Organizer

A cross-platform GUI application that automatically organizes files and folders according to Divyansh's FileStructure and Naming Guide.

Features

  • Automatic File Organization: Drop files into TRAY folder for instant organization
  • Smart Naming: Follows [vX]_[DESC]_[TYPE]_[DDMMYY].ext convention
  • Cross-Platform: Works on Linux, Windows, and macOS
  • Real-time Monitoring: Watches TRAY folder for changes
  • Modern GUI: Clean, intuitive interface with dark/light themes

Quick Start

Installation

  1. Clone the repository:
git clone https://github.com/username/smart-file-organizer.git
cd smart-file-organizer
  1. Create virtual environment:
python3 -m venv venv
source venv/bin/activate
  1. Install dependencies:
pip install -r requirements.txt
  1. Run the application:
python src/main.py

Usage

  1. First Run: Configure your target organization folder
  2. Drop Files: Put any files/folders into the TRAY folder
  3. Automatic Processing: Files are organized and renamed automatically
  4. Monitor: View operations in the application log

File Organization System

Folder Structure

├── 00-INBOX (Downloads, Screenshots, Temp)
├── 01-PROJECTS (PRJ, DOC, NOTE, MEET files)
├── 02-AREAS (INV, CERT, PLAN, RPT files)
├── 03-RESOURCES (Books, Tutorials, Templates)
├── 04-ARCHIVES (Old files)
├── 90-MEDIA (IMG, VID, GIF, SVG files)
├── 91-SOFTWARE (TOOL, CFG, BKUP files)
└── 99-TEMPLATE-LIB (Templates)

Type Codes

  • WORK & PROJECTS: PRJ, DOC, NOTE, MEET
  • BUSINESS & ADMIN: INV, CERT, PLAN, RPT
  • MEDIA & CREATIVE: IMG, VID, EDIT, TMPL, GIF, SVG
  • TOOLS & SYSTEM: TOOL, CFG, BKUP, TEMP

Development

Project Structure

smart-file-organizer/
├── src/
│   ├── core/           # Core logic
│   ├── gui/            # User interface
│   └── utils/          # Utilities
├── config/             # Configuration files
├── tests/              # Test files
└── docs/               # Documentation

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make changes and add tests
  4. Submit a pull request

License

MIT License - see LICENSE file for details.

Author

Based on FileStructure and Naming Guide by Divyansh Joshi