It is recommended to include metadata in all plugins. Metadata includes basic information about the plugin that will allow you to track information about plugins with similar metadata via the web interface as well as the programmatic API. Plugin metadata surfaces key/value properties about your plugin. An example of some of the more common properties are listed below.
- Version: What version of the plugin is this?
- Last updated date: When was this plugin last changed?
- Author: Either the owner of the plugin or the developer who wrote it
- Nickname: Name designated for the plugin.
- Default Language Description: A short description of the plugin, typically written by the plugin author
- Support email: The email address to contact for support
- Support URL: The URL of the plugin support page
- Main URL: The primary URL
- Managed: Whether or not the plugin requires configuration (settings, etc.)
- Category: If set, the plugin will be nested under the provided category for organizational purposes
You can add other properties as you see fit as long as they are in the format listed in the code snippet below.
from DivvyPlugins.plugin_metadata import PluginMetadata class metadata(PluginMetadata): """ Information about this plugin """ version = '1.0' last_updated_date = '2015-08-05' author = 'Divvy Cloud Corp.' nickname = 'CPU Usage' default_language_description = 'Display of CPU data across instances' support_email = 'email@example.com' support_url = 'http://support.divvycloud.com' main_url = 'http://www.divvycloud.com' managed = False category = 'CPU Plugins'