pi-folder-organizer

PiFolderOrganizer

PiFolderOrganizer is a Python package that helps organize files into different categories based on their file extensions.

Installation

You can install PiFolderOrganizer using pip:

pip install pi-folder-organizer

Usage

To use PiFolderOrganizer in your Python code, import the PiFolderOrganizer class:

from pi_folder_organizer import PiFolderOrganizer

Make object of class

pi_organizer=PiFolderOrganizer()

To continue with default cleaning:

pi_organizer.pi_folder_organizer("/path/to/source_folder", "/path/to/destination_folder")

If you want to see which folders and extentions I use:

pi_organizer.get_counter()

This will return you a dictionary of folders and the files list as folder's files. Same for getting extensions

pi_organizer.get_extensions()

This will return you a dictionary of folders and the files tuple of file's extensions.

Customization Options

You can customize the counter dictionary and extensions dictionary according to your preferences. Here's how:

from pi_folder_organizer import PiFolderOrganizer

# Initialize PiFolderOrganizer
pi_organizer = PiFolderOrganizer()

# Customize the counter dictionary
new_counter = {
    "Images": [],
    "Documents": []
}

# Set the new counter
pi_organizer.set_counter(new_counter)
print("Updated Counter:", pi_organizer.get_counter())

# Customize the extensions dictionary
new_extensions = {
    "Images": (".png", ".jpg"),
    "Documents": (".txt", ".docs")
}

# Set the new extensions
pi_organizer.set_extensions(new_extensions)
print("Updated Extensions:", pi_organizer.get_extensions())

# Run the PiFolderOrganizer method after your setup
pi_organizer.pi_folder_organizer("source_folder", "destination_folder")

Note The length of new_counter and new_extensions must be same. The remaining files automatically moved to folder Others.

Contact Information

Feel free to reach out to me on social media:

License

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