Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Utility Package that organizes and moves the specific file types to its type Specific Directories

Project description

Directory Organizer Package

Setup Automated Test passing Python Version PyPI version Last Commit Open Source Love png2

Have a cluttered Folder/Directory? No Worries!

Directory Organizer is a simple Python Package that scans your folder directory and moves the specific file types to its type-specific directories.

Currently Available for All Platform.

Class Documentation

class directory_organizer.organizer(path = 'Downloads', verbose = False)

By default, path = 'Downloads' of the Base OS and verbosity = False ie no output to the console regarding files moved.

Parameters Description
path Absolute path to the directory when we want to perform our operations.
verbose Controls the verbosity ie console output during our operations.

Methods

organizer.showHistory(extension_type = None)
  • Returns a dictionary of the Files that were been moved.
    By default, showHistory() returns dictionary of the all the file types if no argument has been passed.
Parameters Description
extension_type Can be anything among these - ['Documents', 'Pictures', 'Music', 'Videos', 'Archived', 'Programming', Others']

if extension_type is passed as an argument, then a dictionary containing moved files will be returned having extension_type as type.


organizer.showExtensions(extension_type = None)
  • Returns a dictionary of the files extensions that are been supported by the Package currently.
    By default, showExtensions() returns dictionary of the all the file extension types if no argument has been passed.
Parameters Description
extension_type Can be anything among these - ['Documents', 'Pictures', 'Music', 'Videos', 'Archived', 'Programming', Others']

if extension_type is passed as an argument, then a dictionary containing all file extensions having extension_type as type will be returned .


organizer.__version__
  • Returns the current package version number.

About

Categorise your files into Pictures, Documents, Music, Videos, Archived, Programming or as Others!

Pictures will be moved to /home/$user/Pictures for Unix-based systems or c:\user\username\Pictures for Windows, same goes for Documents, Music, Videos etc to their respective folders.

All the classes/methods will be imported under the package directory_organizer.

Further File types will be added to existing types to widen support.

Note :

  • By default, Directory Organizer considers base Downloads Directory of your OS.
  • If the File-type doesn't match with either of Pictures/Documents/Videos/Music/Archived/Programming file extensions, then it'll be moved to Others Directory.

This Package has been developed collectively by @rahulbordoloi and @SouravMzdr which has been published to PyPI.

Installation

Run the following command on your terminal to install directory_organizer:

1 . Installing the Package using pip:

pip install directory_organizer

OR

pip3 install directory_organizer

2 . Cloning the Repository:

git clone https://github.com/rahulbordoloi/Directory-Organizer/
cd directory_organizer
pip install -e .

Usage

Run this Script in order to move all the Files to their respective type folders! [Default]

# Importing Libraries
from directory_organizer import organizer

# Main Method
if __name__ == '__main__':
    organizer()

Outputs

1 . Selecting Directory and Output as DEFAULT

>>> from directory_organizer import organizer
>>> organizer()
Moving Document File Extensions ...
Moving Picture File Extensions ...
Moving Music File Extensions ...
No Videos to Move!
Moving Archived File Extensions ...
Moving Programming File Extensions ...
Moving Other File Extensions ...
Time Elapsed :  0.22 seconds

2 . Selecting a Random Directory with Output True.

>>> from directory_organizer import organizer
>>> organizer('C:\Personal\Work\Directory Organizer\Test\Random', True)
Moving Document File Extensions ...
6 Files moved to Documents!
5_6084888091904966894.pdf
5_6293939556248977731.pdf
798073238.pdf
AWS Bucket.csv
B275D17ApplicationForm.pdf
datasets_1111_2005_kidney_disease.csv
Moving Picture File Extensions ...
2 Files moved to Pictures!
About ME.png
_MG_8632 copy.jpg
No Music Files to Move!
Moving Video File Extensions ...
1 Files moved to Videos!
Narcos - Main Trailer - Netflix [HD].mp4
Moving Archived File Extensions ...
1 Files moved to Archived!
one-dark-theme-5.1.1.zip
Moving Programming File Extensions ...
5 Files moved to Programming!
11263_Good_Bad_Customers.ipynb
11263_HR_Analytics.ipynb
Kidney_Disease.ipynb
monocai.jar
saved_model.pb
Moving Other File Extensions ...
2 Files moved to Others!
ngrok.exe
python-3.8.6.exe
Time Elapsed :  0.07 seconds

Developing Directory Organizer

To install directory_organizer, along with the tools you need to develop and run tests, and execute the following in your virtualenv:

$ pip install -e .[dev]

Security & Bugs

  • As a security measure, this script WILL NOT access files located in any subdirectory unless explicitly stated.
  • Files having the same name as in Source and Target will get Replaced. [Caution]

Contact Author(s)

Name : Rahul Bordoloi
Website : https://rahulbordoloi.me
Email : rahulbordoloi24@gmail.com

Name : Sourav Mazumdar
Email : souravmzdr@gmail.com

forthebadge made-with-python ForTheBadge built-with-love

Project details


Download files

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

Files for directory-organizer, version 1.0.5
Filename, size File type Python version Upload date Hashes
Filename, size directory_organizer-1.0.5-py3-none-any.whl (20.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size directory_organizer-1.0.5.tar.gz (29.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page