Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Trigger custom commands from filesystem events.

Project description

Patrol

Trigger methods from changed files - e.g. selectively rebuild your project or run tests as soon as you hit the save button on your text editor or IDE.

Patrol works well with ProjectKey.

Use

To install:

pip install patrol

Example code:

import patrol

def build(filenames):
    touch("output/build_started")
    time.sleep(2)
    touch("output/build_finished")

def run_test(filenames):
    touch("output/test_started")
    time.sleep(30)
    touch("output/test_finished")

patrol.watch([
        patrol.Trigger(
            build,
            includes=["data/*", ],
            excludes=['data/exclude/*', 'output/*', ],
        ),
        patrol.Trigger(
            run_test,
            includes=["data/*", ],
            excludes=['data/exclude/*', 'output/*', ],
            reaper=patrol.Reaper(),         # If triggered while method is in progress, this will stop it and start it again.
            fire_on_initialization=True,    # When the watch is initiated, this trigger will also fire.
        ),
    ],
    directory=os.getcwd(),            # By default it patrols the present working directory.
    lockfiles=[".git/index.lock", ],  # This will wait until git has finished its operations before firing any triggers
)

Features

  • Patrol does not use polling to detect file changes. It uses libuv, which creates event driven hooks to filesystem events using epoll, kqueue or IOCP.
  • You can queue up triggers when a specified lockfile is present - e.g. you can use to prevent triggers from firing until git operations are done.
  • Patrol comes with a customized Reaper class that can be used to specify how a process is stopped.

Project details


Release history Release notifications

This version
History Node

0.3.1

History Node

0.3

History Node

0.2

History Node

0.1

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
patrol-0.3.1.tar.gz (5.6 kB) Copy SHA256 hash SHA256 Source None Jul 26, 2015

Supported by

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