Skip to main content

Organize files in folders by type

Project description

🗂️ bd_fileorganizer

bd_fileorganizer is a simple yet powerful Python utility that helps you clean up cluttered folders by automatically moving files into categorized subfolders like images/, documents/, archives/, and more — all based on file extensions.

It’s perfect for tidying up your Downloads, Desktop, or project folders with just one command.


📦 Features

  • 📁 Automatically sorts files into categories
  • 🧠 Smart extension detection (.jpgimages, .pdfdocuments, etc.)
  • 🧪 Dry-run mode to preview changes
  • 🐍 Easy-to-use Python API and CLI interface
  • ✅ Beginner-friendly code and customizable

🚀 Installation

Install from source:

git clone https://github.com/your-username/fileorganizer.git
cd fileorganizer
pip install -e .

📌 Coming soon to PyPI!


🖥️ CLI Usage

fileorganizer /path/to/folder

Dry-run (preview only):

fileorganizer /path/to/folder --dry

🐍 Python API

from fileorganizer import organize_folder

organize_folder("/Users/you/Downloads", dry_run=False)

🧪 Running Tests

pytest

🗃️ Folder Structure Example

Before:

Downloads/
├── photo.jpg
├── report.pdf
├── backup.zip

After:

Downloads/
├── images/
│   └── photo.jpg
├── documents/
│   └── report.pdf
├── archives/
│   └── backup.zip

🔧 Extension Mapping

Category Extensions
images/ .jpg, .jpeg, .png, .gif
documents/ .pdf, .docx, .txt
archives/ .zip, .tar, .gz, .rar
videos/ .mp4, .mov, .mkv
audio/ .mp3, .wav
others/ Everything else

📄 License

Licensed under the MIT License


🤝 Contributing

Contributions, feature ideas, and bug reports are welcome! Feel free to open an issue or a pull request.


👤 Author

Your Name GitHub: @your-username


🧹 Make your folders smarter, not messier — with fileorganizer 🗂️

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

bd_fileorganizer-0.0.1.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

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

bd_fileorganizer-0.0.1-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file bd_fileorganizer-0.0.1.tar.gz.

File metadata

  • Download URL: bd_fileorganizer-0.0.1.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.5

File hashes

Hashes for bd_fileorganizer-0.0.1.tar.gz
Algorithm Hash digest
SHA256 54056ce2f15d3929cd6698f4df06ada9d7685828d5d57f5759599a441d60003f
MD5 e44e238bbec01bdeca3d12681ed567d6
BLAKE2b-256 3a1dba5facb31c35732f98b0bcd1aee662c78a40ffb010849fe3eec29c7ec6ef

See more details on using hashes here.

File details

Details for the file bd_fileorganizer-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for bd_fileorganizer-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 74c2c75fd38c9e6174ef9984e9e09cdcd30476b80bd7d34dec834efcb103dbea
MD5 4bf3e3faef3c548bdcd0193c41ff2986
BLAKE2b-256 606d32b670f714faa14a45a875fa0ba1096fd35e86c829e2d1ce5ccb2b4d4cd7

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