Bases: object
Base class for AvoPlot plugins.
Returns a list of control panels (subclasses of AvoPlotControlPanelBase) that are provided by this plugin.
Returns a list of menu entry labels (strings) for this plugin.
get_menu_entry_labels()[:-1] are labels for submenus get_menu_entry_labels()[-1] is the label for the actual menu entry
Returns the tooltip for the menu entry for this plugin.
Returns the parent window to be used for windows created by the plugin. (This will be the main AvoPlot window)
Returns the series type (class) that this plugin is compatible with.
Set the File->New menu entries for this plugin.
tooltip - the tooltip for the menu entry
Bases: distutils.command.install.install
Specialised installer for AvoPlot plug-ins.
Overrides the finalize_options() method of the distutils install class. Ignores any user defined installation directories and sets the install path to be the AvoPlot plugins directory (as returned by get_plugin_install_path())
Bases: avoplot.plugins.AvoPlotPluginBase
Base class for plugins only requiring a single subplot
Generate a new figure object, put a subplot into it, call plot_into_subplot() on the new subplot and then call show_figure() to add the new figure to the main window.
Adds the figure object into the main AvoPlot window as a new tab.
Bases: exceptions.ImportError
Exception class for plugin import errors
Returns the path where plug-ins should be installed. This will be the path that this module is in.
Returns a dict of {name:plugin}, where name is a string, and plugin is an instance of the plugin class (which should be a subclass of AvoPlotPluginBase. If load_all_plugins() has not already been called, then the dict will be empty.
AvoPlot is released under the GPL license. A requirement of this license is that all plugins for AvoPlot are licensed in a GPL compatible way. This function looks in the module for ‘plugin’ (where plugin is an instance of the plugin class) for a variable called plugin_is_GPL_compatible and returns its value. It returns False if plugin_is_GPL_compatible was not defined in the module.
See: http://www.gnu.org/prep/standards/html_node/Dynamic-Plug_002dIn-Interfaces.html
Loads all installed AvoPlot plug-ins. Plugins that cannot be loaded will be skipped and a warning message issued.
Loads a plugin from a file. This function is for loading plugins which have not been installed.
Registers a plugin with AvoPlot. This must be called from within the plugin when it is imported. The plugin argument should be an instance of the plugin class (which must be a subclass of AvoPlotPluginBase)
Replacement for the distutils.core setup function, to be used in setup.py files for AvoPlot plugins. It works exactly the same as the distutils function except that it will set the install path for the plugin to be the plugins directory of AvoPlot (i.e. the path returned by get_plugin_install_path()).