File Organizer Tool

A powerful Python tool to organize files in directories based on their extensions. Features include dry-run preview, undo capability, recursive organization, and custom configuration.

Installation

pip install file-organizer-tool

For YAML config support:

pip install file-organizer-tool[yaml]

For development:

pip install file-organizer-tool[dev]

Quick Start

Command Line

# Basic usage - organize current directory
file-organizer-tool .

# Preview changes without moving files
file-organizer-tool /path/to/folder --dry-run

# Organize with detailed output
file-organizer-tool /downloads --verbose

# Organize subdirectories recursively
file-organizer-tool /messy-folder --recursive

# Undo the last organization
file-organizer-tool /organized-folder --undo

Python Script

from file_organizer_tool import organize_files

# Basic organization
result = organize_files("/path/to/directory")
print(result.summary())

# With options
result = organize_files(
    "/downloads",
    dry_run=True,
    verbose=True,
    recursive=True,
    on_conflict='rename'  # or 'skip', 'overwrite'
)

CLI Options

File Categories

Files are organized into these categories by default:

• images: jpg, png, gif, svg, webp, ico, etc.
• documents: pdf, docx, txt, xlsx, md, csv, etc.
• scripts: py, js, ts, sh, bat, go, rs, etc.
• archives: zip, tar, gz, rar, 7z, etc.
• videos: mp4, avi, mov, mkv, webm, etc.
• audio: mp3, wav, flac, aac, ogg, etc.
• data: json, xml, yaml, sql, db, etc.
• fonts: ttf, otf, woff, woff2, etc.
• executables: exe, msi, dmg, deb, apk, etc.
• others: unrecognized extensions

Custom Configuration

Create a config.json or config.yaml:

{
    "projects": [".sln", ".csproj", ".xcodeproj"],
    "ebooks": [".epub", ".mobi", ".azw3"]
}

Use it:

file-organizer-tool /folder --config config.json

Development

# Clone and install
git clone https://github.com/albizzy/file_organizer
cd file_organizer
pip install -e ".[dev]"

# Run tests
pytest tests/ -v

# Run with coverage
pytest tests/ --cov=file_organizer_tool

License

MIT License - see LICENSE for details.

Author

Albert Mwasisoba (@albizzy)