Part of elisa.plugins.base.models.plugin View In Hierarchy
| 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
) | |
| icons | a list of icons for the plugin
(type: list of elisa.plugins.base.models.image.ImageModel
) | |
| screenshots | a list of screenshot images for the plugin
(type: list of elisa.plugins.base.models.image.ImageModel
) | |
| enabled | whether the plugin is currently enabled (this attribute is not part of the
plugin metadata)
(type: bool
) | |
| Note | this model may be enriched along the way with new metadata | |
| Line # | Kind | Name | Docs |
|---|---|---|---|
| 88 | Method | __init__ | Undocumented |
| 108 | Class Method | from_dict | Class method that instantiates and returns a plugin model from a |
| 172 | Class Method | from_distribution | Class method that instantiates and returns a plugin model from a |
| 196 | Method | runs_on_current_platform | Test whether the plugin is compatible with the current platform. |
| 214 | Method | cache_image | Return the path to the image cached on disk corresponding to the given |
| 151 | Method | _extract_resources | Undocumented |
Inherited from Bindable (via Model):
| Line # | Kind | Name | Docs |
|---|---|---|---|
| 34 | Method | bind | Bind a local attribute to
destination_attribute of |
| 73 | Method | unbind | Remove the binding of attribute to
destination_attribute of |
| 104 | Method | unbind_object | Remove all the bindings you have for a certain
destination_object. |
| 118 | Method | __setattr__ | Undocumented |
| 136 | Method | __delattr__ | Undocumented |
| Parameters | dictionary | a dictionary as provided by the plugin repository
(type: dict
) |
| Returns | a plugin model populated accordingly
(type: PluginModel
) | |
pkg_resources.| Parameters | distribution | a distribution as provided by pkg_resources
(type: pkg_resources.Distribution
) |
| Returns | a plugin model populated accordingly
(type: PluginModel
) | |
| Returns | True if compatible with the current platform,
False otherwise
(type: bool
) | |
If the uri points to a local file, just return its path without caching it. Otherwise, if the image is not cached yet, download it and cache it.
| Parameters | uri | the URI to the image
(type: elisa.core.media_uri.MediaUri
) |
| Returns | the path to the cache file and a deferred triggered when the image is
cached
(type: (str, elisa.core.utils.defer.Deferred)
) | |