An open API service indexing awesome lists of open source software.

https://github.com/animenosekai/folder_cleaner

A folder cleaner script for python
https://github.com/animenosekai/folder_cleaner

Last synced: 4 months ago
JSON representation

A folder cleaner script for python

Awesome Lists containing this project

README

        

# folder_cleaner
A Python script that lets you organize and clean your folders quickly and easily!

[![PyPI version](https://badge.fury.io/py/folderclean.svg)](https://badge.fury.io/py/folderclean)

### Installation

#### WITH PIP
- Run `pip install folderclean` in your command-prompt/terminal

#### MANUALLY
- Download or clone this repository
- Unzip if needed
- You can now directly open `folder_cleaner.py` and start organizing your folders!

> (On macOS you have a special script to open it `Open Folder Cleaner on macOS` because you can't just double click it (it could prompt you to a script editor) )

### Dependencies
- Python 3 (downloadable at https://www.python.org/downloads/)
- LifeEasy
- FileCenter

> Both LifeEasy and FileCenter are libraries written by me and will be installed automatically at first launch.

> This program shows one way of using my libraries.

### Platform/Working OS
- This python script is cross-platform and has been tested on macOS and Windows.

### Usage
Folder Cleaner (for Python) usage is very simple.

#### IF INSTALLED WITH PIP
- Open your command-prompt/terminal in the folder you want to clean (or `cd` into it)
- Run `folderclean`

#### IF INSTALLED MANUALLY
- Open the file (with Python) and you will be prompted to enter the path of the folder you want to review (tips: you can also simply drag and drop the folder into the terminal).
- Type the desired organizing mode and press `enter` to continue.
- The program will do everything else automatically!

### Available organizing mode
- `nosort` > nothing will be sorted in the cleaned up folder.
- `type` > each file will be sorted and put in a folder according to its type.

### Issues
If you have any issue, feel free to go to the issue section of this repository and report it.

### File types
A list of supported file types is available on the [official FileCenter repository](https://github.com/Animenosekai/filecenter#listoftypes)

### Development
Feel free to contribute to the development of this program and to ask for new features in the issue section of the repository!

I am not responsible for any damage that might be caused by my script, or any bad usage of this script.

© Anime no Sekai - 2020