From 3775327aeafeee85c290d53a1da435d0a16b5c88 Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Fri, 20 Jul 2018 19:19:55 +0200 Subject: [PATCH] Updated variable plugin documentation --- platypush/plugins/variable.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/platypush/plugins/variable.py b/platypush/plugins/variable.py index 5d90cdfc2..0bb5166de 100644 --- a/platypush/plugins/variable.py +++ b/platypush/plugins/variable.py @@ -6,12 +6,24 @@ from platypush.plugins import Plugin, action class VariablePlugin(Plugin): """ This plugin allows you to manipulate context variables that can be - accessed across your tasks. + accessed across your tasks. It requires the :mod:`platypush.plugins.db` + plugin to be enabled, as the variables will be stored on a local database + for persistency and multi-process sharing purposes. + + Requires: + + * **sqlalchemy** (``pip install sqlalchemy``) """ _variable_table_name = 'variable' def __init__(self, *args, **kwargs): + """ + The plugin will create a table named ``variable`` on the database + configured in the :mod:`platypush.plugins.db` plugin. You'll have + to specify a default ``engine`` in your ``db`` plugin configuration. + """ + super().__init__(*args, **kwargs) self.db_plugin = get_plugin('db')