Skip to main content

A simple command line utility that organises files in a directory into subdirectories.

Project description

CleanUp

Travis PyPI Python License

A simple command line utility that organises files in a directory into subdirectories based on the files' extensions.

Usage

Usage

When run without any option, it organises the files in the specified directory into subdirectories based on the files' extensions.

Options

  • -d, --dry-run

    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
    
  • -s, --silent

    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
    
  • -r, --revert

    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
    
  • -h, --help

    Displays the help text.

    cleanup -h
    

Development

Setup

  1. Clone the repo and cd into it.

  2. 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
    
  3. The cleanup script can now be run from the root directory of the project:

    python3 -m cleanup.cleanup -h
    

Test

Make sure you're in the root directory of the project. You can then run the test using:

python3 -m tests.test

License

This project is licensed under the terms of the MIT license.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
cleanup-1.0.3-py3-none-any.whl (38.8 kB) Copy SHA256 hash SHA256 Wheel py3 Apr 6, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page