Metadata-Version: 2.1
Name: pushbroom
Version: 0.1.0
Summary: Clean up your filesystem
Home-page: https://github.com/gpanders/pushbroom
License: MIT
Author: Greg Anders
Author-email: greg@gpanders.com
Requires-Python: >=3.4,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Project-URL: Repository, https://github.com/gpanders/pushbroom
Description-Content-Type: text/markdown

# Pushbroom
Keep select filesystem paths free of clutter

## Installation

Directly from source (requires [poetry](https://github.com/sdispater/poetry)):

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

Or from PyPI:

    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.

## Configuration

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

**Path**

Specify which directory to monitor

**Trash**

Specify where to move files after deletion. If this option is not provided,
files will simply be deleted.

**NumDays**

Number of days to keep files in `Path` before they are removed.

**Ignore**

Regular expression pattern of files or directories to ignore.

