Part of elisa.core.plugin View In Hierarchy
Known subclasses: elisa.plugins.base.models.plugin.PluginModel
| Instance Variables | name | the name of the plugin
(type: unicode
) |
| version | the version number of the plugin
(type: distutils.version.LooseVersion
) | |
| author_name | the name of the author of the plugin
(type: unicode
) | |
| author_email | the e-mail address of the author of the plugin
(type: unicode
) | |
| platforms | a list of compatible platforms (typical values are: linux,
win32, macosx)
(type: list of unicode
) | |
| license | the license of the plugin
(type: unicode
) | |
| website | the home page of the plugin
(type: unicode
) | |
| category | a unique category the plugin belongs to
(type: unicode
) | |
| tags | a list of tags that define the plugin
(type: list of unicode
) | |
| egg_name | the egg name
(type: unicode
) | |
| uri | the URI where the egg can be downloaded from
(type: unicode
) | |
| title | a fancy (short) name for the plugin
(type: unicode
) | |
| description | a detailed description of what the plugin does
(type: unicode
) | |
| enabled | whether the plugin is currently enabled
(type: bool
) |
| Line # | Kind | Name | Docs |
|---|---|---|---|
| 64 | Method | __init__ | Undocumented |
| 80 | Method | runs_on_current_platform | Test whether the plugin is compatible with the current platform. |
| 100 | Class Method | from_distribution | Class method that instantiates and returns a plugin object from a |
| 124 | Class Method | from_dict | Class method that instantiates and returns a plugin object from a |
| Returns | True if compatible with the current platform,
False otherwise
(type: bool
) | |
pkg_resources.| Parameters | distribution | a distribution as provided by pkg_resources
(type: pkg_resources.Distribution
) |
| Returns | a plugin object populated accordingly
(type: Plugin
) | |
| Parameters | dictionary | a dictionary as provided by the plugin repository
(type: dict
) |
| Returns | a plugin object populated accordingly
(type: Plugin
) | |