~gpanders/pushbroom

7b1c13ac75fabfbc63537414c5a4197f27b8eb0e — Greg Anders 2 years ago 6ae5513
Update README
3 files changed, 74 insertions(+), 15 deletions(-)

M README.md
M pyproject.toml
M src/pushbroom/sweep.py
M README.md => README.md +72 -10
@@ 1,28 1,84 @@
# Pushbroom
Keep select filesystem paths free of clutter

Pushbroom is a tool designed to help keep your filesystem clear of clutter.
Certain directories, such as your downloads directory, tend to accumulate a
large amount of old files that take up space. Over time, this clutter can
accumulate to a significant amount of storage space. Pushbroom gives you an easy
way to remove these old files.

Pushbroom is written in Python and should therefore work on any platform that
can run Python. For now, it is only officially supported for macOS and Linux.

## Installation

### Homebrew (macOS only)

Install via Homebrew:

    brew install gpanders/tap/pushbroom

Or directly from source (requires [poetry](https://github.com/sdispater/poetry)):
Copy and modify the included `pushbroom.conf` file to
`~/.config/pushbroom/config` and use `brew services start
gpanders/tap/pushbroom` to start the automatic launchd daemon:

    cp -n /usr/local/etc/pushbroom.conf ~/.config/pushbroom/config
    brew services start gpanders/tap/pushbroom

Pushbroom will run once every hour.

    git clone https://github.com/gpanders/pushbroom
    cd pushbroom
    poetry install
### PyPI

Or from PyPI:
Install using pip:

    pip install pushbroom

Pushbroom comes with an example configuration file `pushbroom.conf`. You can
copy this to either `$XDG_CONFIG_HOME/pushbroom/config` or `$HOME/.pushbroomrc` and
modify it to your needs.
### From source

Check the [releases](https://github.com/gpanders/pushbroom/releases) page for
the latest release. Extract the archive and copy the files to their correct
locations:

    tar xzf pushbroom-vX.Y.Z.tar.gz
    cd pushbroom-vX.Y.Z
    cp -r bin /usr/local/
    cp -n pushbroom.conf ~/.config/pushbroom/config

## Configuration

The Pushbroom configuration file is organized into sections where each section
represents a directory path to monitor. The default configuration file looks
like this:

    [Downloads]
    Path = ~/Downloads
    Trash = ~/.Trash
    NumDays = 30

This means that, by default, Pushbroom will monitor your ~/Downloads folder and
move any file or folder older than 30 days into your ~/.Trash directory.

If you don't want to move files into ~/.Trash but instead want to just delete
them, simply remove the `Trash` option:

    [Downloads]
    Path = ~/Downloads
    NumDays = 30

The name of the section (`Downloads` in this example) is not important and can
be anything you want:

    [Home Directory]
    Path = ~
    NumDays = 90

You can also specify an `Ignore` parameter to instruct Pushbroom to ignore any
files or directories that match the given glob:

    [Downloads]
    Path = ~/Downloads
    NumDays = 30
    Ignore = folder_to_keep/**/*

The following configuration items are recognized in `pushbroom.conf`:

**Path**


@@ 40,4 96,10 @@ Number of days to keep files in `Path` before they are removed.

**Ignore**

Regular expression pattern of files or directories to ignore.
Glob expression pattern of files or directories to ignore.

## Similar Work

- [Belvedere](https://github.com/mshorts/belvedere): An automated file manager
  for Windows
- [Hazel](https://www.noodlesoft.com/): Automated Organization for your Mac

M pyproject.toml => pyproject.toml +1 -4
@@ 6,10 6,7 @@ authors = ["Greg Anders <greg@gpanders.com>"]
license = "MIT"
readme = "README.md"
repository = "https://github.com/gpanders/pushbroom"
include = ["pushbroom.conf"]
packages = [
    { include = "pushbroom", from = "src" },
]
include = ["README.md", "CHANGELOG.md", "pushbroom.conf"]

[tool.poetry.scripts]
pushbroom = "pushbroom.console:run"

M src/pushbroom/sweep.py => src/pushbroom/sweep.py +1 -1
@@ 11,7 11,7 @@ def sweep(path, num_days, ignored, trash=None, dry_run=False):

    :path: Path to remove files from
    :num_days: Remove files older than this many days
    :ignored: Regex pattern of paths to ignore
    :ignored: Glob pattern of paths to ignore
    :trash: If set, move files to this directory instead of deleting them
    :dry_run: Only show what would happen without actually doing anything