Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 1.81 KB

plugins.rst

File metadata and controls

63 lines (42 loc) · 1.81 KB

Using Plugins

We can use configuration files <configuration> to customize Wiz, but we can also extend the configuration mapping with dynamic values using Python plugins.

Hint

Plugins are being discovered and loaded just after configuration mapping has been created from configuration files <configuration>. So any modification to the configuration mapping done in the plugins will always overwrite the content of the configuration files <configuration>.

Default plugins

The following plugins are located in wiz/package_data/plugins. They are used by default, unless modified during the installation process <installing/source/options>.

environ

This plugin adds initial environment variable to the configuration mapping.

../source/wiz/package_data/plugins/environ.py

installer

This plugin adds an installer callback to the configuration mapping to indicate how a definition can be installed using wiz install.

../source/wiz/package_data/plugins/installer.py

Adding new plugins

More plugins can be added in ~/.wiz/plugins for development purpose. The default plugins will always be loaded first, followed by the personal plugins.

A plugin is uniquely identified by the IDENTIFIER data string. Therefore, you can overwrite a plugin by re-using the same identifier.

Hint

It is highly recommended to deploy custom plugins when installing <installing/source/options> the package instead of using it from the personal plugin path as it can be error prone.