Plugins

Since moneyGuru v2.5, it’s possible to expand moneyGuru’s capability through Python plugins. Plugins are Python 3 source files that come in two flavors: “core” and “user. Core plugins are bundled directly in moneyGuru and are enabled by default. User plugins are located in the plugin folder (the location of that folder depends on the system, but you can open that folder through “File –> Open Plugin Folder”) and are disabled by default. To install a new user plugin, you can simply copy the python source file of that plugin in that folder and restart moneyGuru.

You can enable and disable plugins through the “Plugin management” view, available whenever you open a new tab. Simply check/uncheck the box next to the plugin you want to enable/disable and restart moneyGuru.

Warning. moneyGuru plugins are not sandboxed, which means that technically, they could contain malicious code. Only install plugins from trusted sources or after having reviewed the code yourself.

Plugin types

Plugins are still relatively new in moneyGuru’s design and they don’t allow a hugely broad range of capabilities. For now, this is the types of plugins that are supported:

  • Read-only tables (ReadOnlyTablePlugin)
  • Currency providers (CurrencyProviderPlugin)
  • Import Actions (ImportActionPlugin)
  • Import match bindings (ImportBindPlugin)

The “Read-only table” type is a “view” kind of plugin, that is, it creates a new tab type. When this type of plugin is installed, a new entry will appear in the “Plugins” list of the New Tab view. Simply double-click on it to open it. The data in those tables is not “live” data and thus isn’t refreshed when data in the document changes, so the tab has to be closed and reopened for the data to be refreshed.

But despite that limitation, there’s quite a lot of possibilities, especially for custom reports. Printing, sorting and CSV-copy-pasting (selecting rows, copying data and then pasting it in Excel/Numbers) work with those tables.

Currency providers allow you to create new currencies besides builtin ones and define a way to fetch exchange rates information for these currencies. When enabled, they’ll add currencies to the system and that currency will be usable in the same way as with any other currency.

Import actions allow us to define new actions to perform on transactions about to be imported. You know, those “Day <–> Month” swap things? They’re import actions. So, adding a new plugin of this type will add new options to this list.

Import match bindings are plugins that allow us to re-define the way we do automatic matching when importing transactions in an existing account. For now, we only have one core plugin of this type that match transactions based on IDs supplied by the OFX format. If you add a plugin of that type, additional criterias will be used for matching (for example, you could match based on date+amount).

Creating a plugin

There’s a small convenience API, but it’s a rather slim one. You’re mostly coding straight on top of moneyGuru’s code. There’s a developer documentation telling you about moneyGuru’s API as a whole.

So, to create a plugin, I’d suggest that you take one of the examples (available on Github), duplicate it and try to wade your way through with example comments.

I’m very interested in knowing about plugin development efforts so don’t hesitate to contact me if you need help with the development of your plugin.