fabaff
/
platypush
forked from platypush/platypush
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated variable plugin documentation

This commit is contained in:
Fabio Manganiello 2018-07-20 19:19:55 +02:00
parent 26a57c9d6f
commit 3775327aea
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
platypush/plugins/variable.py
View File

@ -6,12 +6,24 @@ from platypush.plugins import Plugin, action
class VariablePlugin(Plugin): class VariablePlugin(Plugin):
""" """
This plugin allows you to manipulate context variables that can be 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' _variable_table_name = 'variable'
def __init__(self, *args, **kwargs): 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) super().__init__(*args, **kwargs)
self.db_plugin = get_plugin('db') self.db_plugin = get_plugin('db')