Skip to main content

A small tool to periodically move old files into the local file system trash.

Project description

GarbageTruck

https://img.shields.io/pypi/v/garbagetruck.svg https://img.shields.io/travis/bradrf/garbagetruck.svg Documentation Status Updates

A small tool to periodically move old files into the local file system trash.

Features

Use GarbageTruck to build and maintain scheduled cleanup of files in various directories that tend to collect files over time. GarbageTruck will send any files older than a relative period to the local file system trash using the current user’s crontab to schedule checks for old files from cron. This makes the utility safe in that any files moved to the trash could be restored simply without worrying about immediate loss (until the trash is emptied, of course).

For example, let’s say one never cleans out their downloaded files. Here’s how to set a GarbageTruck job to periodically move files older than six months into the trash:

$ garbagetruck set --older-than '6 months' --check-every day 'Clean out old downloads' ~/Downloads/

This will set up a schedule (using cron) to look for files each day that are older than three montsh and have them moved into the correct trash (courtesy of send2trash). The details can be shown like this:

$ garbagetruck -l debug list
[2016-09-03T15:55:32-0700 #31693] INFO     garbagetruck Job 57d1db0a8b8427c3041ac1af89b0a348: name="Clean out old downloads" dirs=["/Users/brad/Downloads"] files_older_than="3 months" check_every="day"
[2016-09-03T15:55:32-0700 #31693] DEBUG    garbagetruck * 1 * * * /Users/brad/.virtualenvs/garbage_truck/bin/garbagetruck run 57d1db0a8b8427c3041ac1af89b0a348 # GarbageTruck: Clean out old downloads

Each call to the set command will replace the same named job. Alternatively, if the job is no longer useful, remove it like this:

$ garbagetruck remove 'Clean out old downloads'

To check on a job, any problems and results will be logged to one of the following locations:

  • OS X will use ~/Library/Logs/garbagetruck.log.
  • Other systems will rely on what click_app_dir returns.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2016-09-02)

  • First release on PyPI.

Project details


Release history Release notifications

This version
History Node

0.1.0

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
garbagetruck-0.1.0-py2.py3-none-any.whl (9.8 kB) Copy SHA256 hash SHA256 Wheel 2.7
garbagetruck-0.1.0.tar.gz (24.4 kB) Copy SHA256 hash SHA256 Source None

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 SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page