Skip to main content

Python package to organize a folder in sub-directories based on file types.

Project description

pyFolderOrganizer

Read the docs PyPI Downloads Last Commit

Python package to organize a folder in sub-directories based on file types.

Documentation

View documentation on Readthedocs

Setup

You can install this package from:

From GitHub:

pip install git+https://github.com/kotsiossp97/pyFolderOrganizer.git@latest

From PIP:

pip install pyFolderOrganizer

Usage

Basic Example

import pyFolderOrganizer

path = "path/to/be/organized"
organizer = pyFolderOrganizer.FolderOrganizer(path)

Observer Mode

Package offers "Observer Mode" that listens for any file created in the directory that the organizer is set to. Creates a thread and when a new file is detected, is automatically moved to the corresponding folder depending of the file extension.

organizer = pyFolderOrganizer.FolderOrganizer(path, observe=True)

Enable/Disable Windows Toasts

Set the notifications argument to True to enable windows notifications on startup and when a file gets organized. Clicking the notification opens an explorer window to the corresponding path. This is turned off by default.

organizer = pyFolderOrganizer.FolderOrganizer(path, notifications=True)

Enable/Disable Console Printing

By default, the package prints messages on the console, equivalent to the notifications. This can be turned off by setting the printing argument:

organizer = pyFolderOrganizer.FolderOrganizer(path, printing=False)

Available Extensions

These are the folders that will contain the files with the provided extensions. Folders are auto created, so no need to create any of them.

Folder Name Extensions
PDF .pdf
CodeFiles .py, .c, .cpp, .java, .h, .html, .php, .js, .tsx
OfficeFiles .txt, .doc, .docx, .xls, .xlsx, .accdb, .ppt, .pptx
MusicFiles .mp3, .wav, .flac
ImageFiles .jpg, .jpeg, .png, .gif, .dds
Compressed .zip, .rar, .7z, .gz
Executables .exe, .msi
General All other file extensions

Add custom folder/extension

To-do

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

pyFolderOrganizer-0.0.1b0.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

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

pyFolderOrganizer-0.0.1b0-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

Details for the file pyFolderOrganizer-0.0.1b0.tar.gz.

File metadata

  • Download URL: pyFolderOrganizer-0.0.1b0.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.0

File hashes

Hashes for pyFolderOrganizer-0.0.1b0.tar.gz
Algorithm Hash digest
SHA256 56016c80ef09e7a961a9ce677b3de8ffac7b705b0d410765f396dec3d3ff02f4
MD5 f050da8f6a86b8be8a90158c3c45c8a6
BLAKE2b-256 395fcff4652188ad8bcd29fdd05147e8c09128041eb22b131ccfb4f74abeac4f

See more details on using hashes here.

File details

Details for the file pyFolderOrganizer-0.0.1b0-py3-none-any.whl.

File metadata

File hashes

Hashes for pyFolderOrganizer-0.0.1b0-py3-none-any.whl
Algorithm Hash digest
SHA256 dce23e9e70d14441c010e08dc8ea63ac1624e56f4744eddedbec31a778be6748
MD5 077a6ac392f0069ae5439789b4577228
BLAKE2b-256 5176c346224394b4e8dab6523102a917d104caebf755a2805d8ab1de7436663f

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