FeedSpool Plugin API
One of the core features of FeedSpool is the plugin API. The goal of this API is to allow tinkerers and developers to hook into the major events of FeedSpool operations. So, when scans start, feeds are polled, and new entries arrive, this API offers hooks for plugins to be notified of these events.
The core of every plugin is an instance of a Python class implementing one or more methods responding to named event hooks. Something thing to keep in mind, however, is that this class could just be a very lightweight connector. The work doesn't have to all be done in Python.
A plugin class could consist entirely of statements executing scripts written in BASH, or methods that feed information via a pipe or socket to a separate process written in Java or Perl.
Hooks
Until I get a chance to properly document these, here's a list of current hooks:
- startup
- adding_feed
- removing_feed
- scan_start
- feed_scan_start
- feed_poll_start
- feed_new_entries
- feed_no_new_entries
- feed_poll_error
- feed_poll_end
- feed_scan_end
- scan_end
- shutdown
