-
Notifications
You must be signed in to change notification settings - Fork 39
Plugins
As of version 0.20, all of the parts of the commit message flashbake generates come from plugins.
As of version 0.22, the names of the stock plugins changed. This reflects the shift to implementing them as classes rather than modules.
There are four stock plugins:
flashbake.plugins.timezone:TimeZone
flashbake.plugins.weather:Weather
flashbake.plugins.uptime:UpTime
flashbake.plugins.feed:Feed
These are enabled by adding the a “plugins:” line or lines to your .flashbake file.
plugins:flashbake.plugins.timezone:TimeZone,flashbake.plugins.weather:Weather plugins:flashbake.plugins.feed:Feed
flashbake will combine multiple “plugins:” lines to create the total list of plugins to use.
Plugins should extend the class flashbake.plugins.AbstractMessagePlugin. If a plugin uses the network, it should implementing an init that takes a plugin_spec string and call the super init passing in that string along with a True argument to indicate the plugin is connectable. See Feed and Weather for examples.
A plugin may implement an init method that takes a ControlConfig argument. In the init(self, config) method, the plugin may call the parent’s requireproperty and optionalproperty methods. These methods take a name argument, the name of an option in the control file that should be set as a property on the plugin itself. optionalproperty also takes an optional argument, a type, to which the option value string will be coerced. See Feed for examples of both of these methods being used.
There is also a shareproperty method from the flashbake.ControlConfig class that sets the option as a property on the config instance and on the plugin. See Weather for an example.
This plugin just adds the configured time zone on your computer to the commit message. It tries a few things to determine the timezone.
As of 0.22, the search for a TZ setting has been changed.
- It will look for a line, “timezone_tz:” in the project’s flashbake file or the user’s .flashbake/config file and use that if present.
- It looks for an environment variable, TZ, which many Linux distros set.
- If that is not set, it will look for a file, “/etc/timezone”, and try to read it. Other Linux distros will create and write this file.
- If that fails, it will look for a symbolic link, “/etc/localtime”, and parse the name of the file to which it points. This is common on Macs.
If all of these fail, then it will write a line to that effect in the commit message.
As of 0.22, this plugin will first use a “weather_city:” option if in the user’s config or the project’s config.
If there is no “weather_city:” this plugin uses the same logic as the timezone plugin to get a timezone value. It then parses that as the most common timezone names follow the form of “Continent/City_name”. It will parse out the city and fix it to drop out the underscore, if there is one. It then calls an undocumented Google API to get weather data as an XML file which it parses to construct a nice, readable line for the commit message.
This plugin read the file, “/proc/uptime”, and parses its contents to generate a human readable amount of time that your computer has been up and running. This plugin will only work on Linux.
This plugin requires some addition lines in your .flashbake configuration file.
As of 0.22 these have been renamed.
- feed_url: – where is the URL to a feed that you want the plugin to read. It can be any feed, but most likely you’ll want to use the one for your blog. As of 0.22, both RSS and Atom feeds should work.
- feed_author:<author’s name> – (optional as of 0.22) where <author’s name> is the name of the author in the feed, exactly as it appears in the feed. The plugin will only output feed items that match this author value.
- feed_limit: – (optional as of 0.22) where is the maximum number of items to pull from the feed, default is 5 if unset.
As of 0.22, if you use the feed plugin, feed_url must be specified.