pyjen.plugin module

Interface for interacting with Jenkins plugins

class pyjen.plugin.Plugin(plugin_config)[source]

Bases: object

Abstraction around one Jenkins plugin

Parameters

plugin_config (dict) – 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)[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

property download_url

URL where the version of this plugin may be downloaded

Type

str

property enabled

checks to see if this plugin is enabled or not

Type

bool

property info_url

the URL for the website describing the use of this plugin

Type

str

property latest_download_url

URL where the latest version of this plugin can be downloaded

Type

str

property long_name

the descriptive name of this plugin

Type

str

property required_dependencies

metadata describing the plugins this plugin depends on. Nested dictionaries contain the ‘shortName’ and ‘version’ fields for use by the caller.

Type

list (dict)

property short_name

the abbreviated name of this plugin

Type

str

property version

the version of this plugin

Type

str