Config

This module contains the global configuration for agate. Users should use get_option() and set_option() to modify the global configuration.

Available configuation options:

agate.config.get_option(key)

Get a global configuration option for agate.

Parameters:key – The name of the configuration option.
agate.config.set_option(key, value)

Set a global configuration option for agate.

Parameters:
  • key – The name of the configuration option.
  • value – The new value to set for the configuration option.
agate.config.set_options(options)

Set a dictionary of options simultaneously.

Parameters:hash – A dictionary of option names and values.