Addon:Plugin ManagerV2

From Gramps
Jump to: navigation, search

Please use carefully on data that is backed up, and help make it better by reporting any comments or problems to the author, or issues to the bug tracker
Unless otherwise stated on this page, you can download this addon by following these instructions.
Please note that some Addons have prerequisites that need to be installed before they can be used.
This Addon/Plugin system is controlled by the Plugin Manager.

Warning this Replaces the standard built-in original Plugin Manager

If you want to return to the original plugin manager, use Plugin Manager Enhanced to uninstall itself, listed as "Plugin Manager Enhanced".

Plugin Manager Enhanced (version 2) - showing example plugins listing

The Plugin Manager Enhanced addon provides a single unified dialog that combines the Registered and Loaded plugins with all the available 3rd party plugins replacing the original plugin manager

Note: This page is for the manager used with Gramps 5.2, and documents the updates to make it work with Gramps 5.2.


Replaces the built-in "Help > Plugin Manager"

Accessed by using the standard menu Help->Plugin Manager.

The first time you use the addon in a session, it will connect to the internet and retrieve the current 3rd party addons list.


  • Single unified dialog combining Registered and Loaded plugins with all the available 3rd party plugin addons.
  • Status column indicates status of Addon, Available, Installed, Built-in, Update Available, and hidden (via strike-through). A Failed addon also displays 'Failed' status in red.
  • All of Available, Installed, and Built-in plugins can be hidden from the dialog list, and if installed, hidden from the normal user interface.
  • A "Show hidden items" checkbox allows the user to see addons that have been hidden.
  • A "Show built-in items" checkbox allows the user to see built-in addons if desired.
  • 'Available' and 'Update Available' addons can be installed from Addons pane, the Install button becomes active when this is possible.
  • Installed addons can be un-installed from Addons pane; the Uninstall appears when this is possible.
  • A Wiki button will launch a wiki page for the Addon/Plugin if one is available.
  • The lower pane provides information on all addon types; includes 'Loaded' and failure type and stack traceback, when applicable.
  • If Gramps is in 'debug' mode, the Load, and Edit buttons appear; load and edit are greyed out when addon is not installed.
  • After updates of View mode plugins or Gramplets, or uninstalls, the user is reminded to restart Gramps.
  • A Search box is available which will filter the dialog to only those addons which have a row or filename which include all the search terms.

Technical details

The Plugin Manager Enhanced addon uses the the plugin system to replace the original plugin manager. It installs itself as a "Plugin lib" early in the Gramps startup sequence. It patches itself into the Gramps Help Menu instead of the original Addon Manager.

Gramps 'debug' mode is started if the optimize option for Python Python -O is ommitted.