8. Plugins guide¶

8.1. Commands¶

8.1.1. `plugins.list`¶

List installed plugins.

Note: if you have a version named dev_link, the plugin is installed as a symbolic link to a source directory. It’s a kind of “development mode”.

8.1.2. `plugins.install`¶

Install a given plugin (.plugin) file.

8.1.3. `plugins.uninstall`¶

Uninstall a given plugin name (not file). The name corresponds to the first column of plugins.list output.

8.1.4. `plugin_env`¶

If you have a virtualenv in your plugin or if you want to simulate the exact environment your code will run in the context of your plugin, you can use the plugin_env interactive command.

If you are developping, the best way is to go in the root directory of your plugin and use plugin_env without argument.

If you have a “normal” installed plugin, you can use plugin_env {PLUGIN_NAME}.

When you are inside a plugin environment, you will find some extra environment variables:

Output:

# Example with MFSERV, but it's the same idea with MFDATA or MFBASE
MFSERV_CURRENT_PLUGIN_NAME=dashboard
MFSERV_CURRENT_PLUGIN_DIR=/home/mfserv/var/plugins/dashboard
MFSERV_CURRENT_PLUGIN_LABEL=plugin_dashboard@mfserv

And of course, paths of your plugin “layer” (kind of virtualenv generalization) are loaded before system paths.

8.1.5. `plugin_wrapper`¶

This command follows the same idea than plugin_env but in a non-interactive way. Use it for example for crontabs or if you want to execute a command in a given plugin environment without changing anything to the current shell.

Output:

plugin_wrapper {PLUGIN_NAME} {COMMAND} [{COMMAND_ARG1}] [{COMMAND_ARG2}] [...]

Note: the plugin must be installed

8.1.6. Inside your plugin env¶

8.1.6.1. make develop¶

Install your plugin in “development mode” (you don’t need to release and install each time you make a modification), the plugin installed through a symlink.

8.1.6.2. make release¶

Release your plugin as a “.plugin” file.

8.1.6.3. make clean¶

Clean (before release)

8.1.6.4. make superclean¶

Hard-clean, can be useful when you have error with your virtualenv

8.1.6.5. make¶

Build your virtualenv from sources

8.1.6.6. python3_virtualenv_sources/requirements-to-freeze.txt¶

Add you python3 dependencies inside this file

FIXME: explain requirements3.txt and the differences with requirements-to-freeze.txt and how the freeze of versions is managed

8.1.6.7. python2_virtualenv_sources/requirements-to-freeze.txt¶

Add you python2 dependencies inside this file