pyjen.plugin module¶
Interface for interacting with Jenkins plugins
-
class
pyjen.plugin.
Plugin
(plugin_config)[source]¶ Bases:
object
Abstraction around one Jenkins plugin
Constructor :param dict plugin_config:
Parsed Jenkins API data associated with this plugin. Typically this content is produced by the Jenkins plugin manager API. See
PluginManager
for details.-
download
(output_folder, overwrite=False, show_progress=False)[source]¶ Downloads the plugin installation file for this plugin
- Parameters
output_folder (str) – path where the downloaded plugin file will be stored
overwrite (bool) – indicates whether existing plugin files should be overwritten in the target folder
show_progress (bool) – indicates whether a progress bar should be displayed as the plugin is downloaded
-
download_url
¶ URL where the version of this plugin may be downloaded
-
enabled
¶ Checks to see if this plugin is enabled or not
-
info_url
¶ Gets the URL for the website describing the use of this plugin
-
latest_download_url
¶ URL where the latest version of this plugin can be downloaded
-
long_name
¶ Gets the descriptive name of this plugin
-
required_dependencies
¶ list of the dependencies this plugin needs in order to work correctly
- Returns
list of 0 or more dictionaries containing the ‘shortName’ and ‘version’ of all dependencies
-
short_name
¶ Gets the abbreviated name of this plugin
-
version
¶ Gets the version of this plugin
-