tidyfiles 0.7.0a1

TidyFiles is a user-friendly, lightweight CLI tool designed to bring order to your Downloads (or any other) folder! It intelligently organizes files by type and keep logs of all the sorting magic.

TidyFiles

TidyFiles is a user-friendly, lightweight CLI tool designed to bring order to your Downloads (or any other) folder! It intelligently organizes files by type and keeps logs of all the sorting magic.

🌟 Features

• Smart Organization: Automatically categorizes files by type (images, documents, videos, etc.)
• Dry Run Mode: Preview changes with --dry-run before actual organization
• Flexible Configuration: Customize source and destination directories
• Detailed Logging: Track all operations with console and file logging
• Rich CLI Interface: Beautiful command-line interface with progress indicators
• Safe Operations: Maintains file integrity during organization

🔧 Tech Stack

• Core Dependencies

  • Python >=3.10: Modern Python features
  • Typer: Elegant CLI interface
  • Rich: Beautiful terminal formatting
  • Loguru: Advanced logging
  • Click: CLI framework (Typer dependency)

• Development Tools

  • Ruff: Fast Python linter and formatter
  • Pre-commit: Automated code quality checks
  • Semantic Release: Automated versioning

• Testing Framework

  • PyTest: Comprehensive test coverage
  • Coverage reporting: Detailed test coverage analysis

🚀 Getting Started

Installation

pip install tidyfiles

Basic Usage

tidyfiles --source-dir /path/to/your/downloads

Advanced Usage

# Dry run to preview changes
tidyfiles --source-dir ~/Downloads --dry-run

# Specify custom destination
tidyfiles --source-dir ~/Downloads --destination-dir ~/Organized

# Custom logging
tidyfiles --source-dir ~/Downloads --log-console-level DEBUG

📁 Example Organization

Before

Downloads/
├── photo.jpg
├── document.pdf
├── video.mp4

After

Downloads/
├── images/
│   └── photo.jpg
├── documents/
│   └── document.pdf
├── videos/
│   └── video.mp4

📝 Logging

TidyFiles generates detailed logs in:

• Console output (configurable level)
• Log file (~/.tidyfiles/tidyfiles.log)

🛠️ Contributing

We welcome contributions! Check out our Contributing Guidelines.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

🎯 Roadmap & Development

Upcoming Features (v0.7.0)

• ↩️ Reversible Operations: Easily undo recent file organizations with --undo command.
• 💾 History System: Browse and restore previous file organizations.
• ⚡ Reliable Processing: Resume interrupted operations where they left off, ensuring operations can be continued or undone based on the saved history.
• 🔐 Safety Checks: Verify file integrity before and after operations to ensure reliable processing.

Future Roadmap (v0.8.0+)

• 🛈 Info Feature Expansion: Enhance the info feature to provide detailed metadata and file information.
• 🌐 Multi-language Interface: Switch between different languages using --lang flag for global accessibility.
• 📁 Custom Categories: Define your own file categories and organization rules via simple configuration.
• 🗂️ Smart Subdirectories: Create dynamic folder structures based on file metadata and patterns.
• 🔍 Smart Deduplication: Intelligently detect and handle duplicate files while preserving the newest versions.
• ✨ Advanced Renaming: Bulk rename files using patterns, dates, and custom templates.
• 🤖 AI Organization: Use AI to categorize files based on content, not just extensions.
• 🖥️ GUI Interface: Optional graphical interface for users who prefer visual file management.
• ☁️ Cloud Integration: Direct organization of Dropbox and Google Drive folders.
• ⏰ Scheduled Tasks: Set up automatic organization at specified times or intervals.
• 🗜️ Smart Compression: Automatically compress old or large files to save space.
• 📊 Organization Presets: Save and share your favorite organization patterns.
• 📈 Usage Analytics: Track space savings and organization patterns over time.
• 🔄 Silent Updates: Seamless background updates with rollback support.
• 🎨 Terminal Themes: Customize CLI appearance with modern color schemes.
• 🔔 Smart Notifications: Get notified when long-running operations complete.
• 📱 Remote Control: Monitor and manage operations from your mobile device.

For detailed version history and latest changes, see our CHANGELOG 📈

📊 Stats

• First Release: March 2025
• Latest Version:
• Python Compatibility:
• Platform Support: Windows, macOS, Linux

Created with ❤️ by Serhii Ryzhaiev