A simple command line utility that organises files in a directory into subdirectories.
A simple command line utility that organises files in a directory into subdirectories based on the files' extensions.
When run without any option, it organises the files in the specified directory into subdirectories based on the files' extensions.
Just displays the changes that would be made, without actually doing anything.
cleanup -d path/to/dir # dry run the cleanup cleanup -dr path/to/dir # dry run the reverting a cleanup
Prevents displaying any information while performing operations. Errors, however, are displayed irrespective of whether this option is enabled or not.
cleanup -s path/to/dir # silently cleanup cleanup -sr path/to/dir # silently revert a cleanup
Reverts the cleanup of a directory. Note that for this to work, the specified directory should have been cleaned up before.
cleanup -r path/to/dir # revert the cleanup of a directory
Displays the help text.
Clone the repo and
Set up a Python 3 virtual environment using pipenv:
pipenv --three # create Python 3 virtual environment pipenv install --dev # install all dependencies pipenv shell # activate virtual environment shell
The cleanup script can now be run from the root directory of the project:
python3 -m cleanup.cleanup -h
Make sure you're in the root directory of the project. You can then run the test using:
python3 -m tests.test
This project is licensed under the terms of the MIT license.