tulipplugins module API

This module provides utility functions to register Tulip plugins written in Python in the plugins database. These functions should only be used inside a module that contains a class implementing a Tulip plugin.

tulipplugins.registerPlugin(pluginClassName, pluginName, author, date, info, release)

Registers a Tulip plugin written in Python in the plugins database.

Parameters:
  • pluginClassName (string) – the name of the Python class implementing the plugin
  • pluginName (string) – the name of the plugin as it will appear in the interface and that will be used to call it
  • author (string) – the name of the plugin’s author
  • date (string) – the date of creation of the plugin
  • info (string) – some informations relative to the plugin
  • release (string) – the version number of the plugin in the form X.Y
tulipplugins.registerPluginOfGroup(pluginClassName, pluginName, author, date, info, release, group)

Registers a Tulip plugin written in Python in the plugins database and inserts it in a specific group.

Parameters:
  • pluginClassName (string) – the name of the Python class implementing the plugin
  • pluginName (string) – the name of the plugin as it will appear in the interface and that will be used to call it
  • author (string) – the name of the plugin’s author
  • date (string) – the date of creation of the plugin
  • info (string) – some informations relative to the plugin
  • release (string) – the version number of the plugin in the form X.Y
  • group (string) – the name of the group in which the plugin will be inserted

Previous topic

tulip module API

This Page