config

Platypush documentation

`config`#

Description#

This plugin can be used to programmatically access the application configuration.

Configuration#

config:
    # No configuration required

Actions#

config.dashboards

config.get

config.get_backends

config.get_config_dir

config.get_config_file

config.get_dashboard

config.get_device_id

config.get_plugins

config.get_procedures

Module reference#

class platypush.plugins.config.ConfigPlugin(**kwargs)[source]#

Bases: Plugin

This plugin can be used to programmatically access the application configuration.

__init__(**kwargs)#

dashboards() → dict[source]#: Get the configured dashboards.

get() → dict[source]#: Get the current configuration.

get_backends() → dict[source]#: Get the configured backends.

get_config_dir() → str[source]#

Returns:: The path to the configuration directory.

get_config_file() → str[source]#: Get the path to the main configuration file.

get_dashboard(name: str) → str[source]#: Get a dashboard configuration by name.

get_device_id() → str[source]#: Get the configured device_id.

get_plugins() → dict[source]#: Get the configured plugins.

get_procedures() → dict[source]#: Get the configured procedures.