Skip to main content

A powerful file organization tool

Project description

OrganiserPro

PyPI Python Version Tests Codecov License: MIT Code style: black Documentation Status

OrganiserPro is a powerful, cross-platform command-line tool for sorting, deduplicating, and managing your files with ease. Keep your files tidy—sort, organize, and eliminate clutter in seconds.


✨ Features

  • Smart File Sorting

    • Sort files by type (extension)
    • Organize by modification or creation date
    • Customizable date formats
    • Dry-run mode to preview changes
  • Duplicate Detection

    • Find duplicate files by content
    • Remove or move duplicates automatically
    • Recursive directory scanning
  • User-Friendly

    • Beautiful terminal output powered by rich
    • Progress bars for long operations
    • Clear error messages and comprehensive help system

🚀 Installation

Prerequisites:

  • Python 3.7 or higher
  • pip (Python package manager)

The recommended way to install OrganiserPro is in a virtual environment.

# Create and activate a virtual environment (recommended)
python3 -m venv organiserpro-env
source organiserpro-env/bin/activate  # On Windows use: organiserpro-env\Scripts\activate

# Install OrganiserPro from PyPI
pip install organiserpro

Note for Ubuntu/Debian/Python 3.12+ users:
If you try to install system-wide with pip, you may see an externally-managed-environment error due to recent changes in Python packaging (PEP 668).
Using a virtual environment avoids this problem and keeps your Python setup clean.

For more help, see the Python packaging user guide.


🏁 Quickstart

Sort your Downloads folder by file type:

organiserpro sort --directory ~/Downloads

Remove duplicate files in a folder:

organiserpro deduplicate --directory ~/Pictures

Preview actions before making changes:

organiserpro sort --directory ~/Documents --dry-run

See more in the Documentation.


📸 Example Output

[16:32:01] Sorting 150 files in /Users/you/Downloads
┣━━ Images (43)
┣━━ Documents (58)
┣━━ Archives (22)
┣━━ Others (27)
✔ All files sorted in 2.3 seconds.

(Add a screenshot or GIF here if possible for more visual appeal!)


📚 Documentation


🤝 Contributing

We love contributions! Please see our Contributing Guide, Code of Conduct, and Security Policy.


🛡 License

MIT License © The Solution Desk


💬 Need Help?


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

organiserpro-0.1.0.tar.gz (38.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

organiserpro-0.1.0-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

Details for the file organiserpro-0.1.0.tar.gz.

File metadata

  • Download URL: organiserpro-0.1.0.tar.gz
  • Upload date:
  • Size: 38.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for organiserpro-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2bd39ba0511806113daf1079d6a9a7a1c453af76b4fb88ca3f5683a3539e64a7
MD5 a746d6fd0e22fab38ebfc2c041549681
BLAKE2b-256 c9998a7303ae42cd2b6d0eb78f257f6d1efef5cb17726b74eb642d98896afe55

See more details on using hashes here.

File details

Details for the file organiserpro-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: organiserpro-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for organiserpro-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a317bb5711bc513692e4272c62ca78ec1c8de8eebac63d25abeff0cdaf7c98dd
MD5 2a919cd80f662ea0e2db61c2a2902be1
BLAKE2b-256 55764d7738d8733cfffdcd763642c6330174999378d67cbcebc51da9c5d5699f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page