Skip to content

Config_Client

Keith Sterling edited this page Feb 21, 2019 · 2 revisions

Client Configuration

Program-Y ships with a number of ways to run the bot. Many of these clients have their own specific configuration settings to control how they operate.

However there are some config options which are generic to all clients as follows

The name of the configuration setting is always the name of the client, in this example the client is 'console' and its what the config loaded looks for when loading the Console Configuration option.

console:
  bot:  bot
  bot_selector: programy.clients.client.DefaultBotSelector
  renderer: programy.clients.render.text.TextRenderer
  scheduler:
    name: Scheduler1
    debug_level: 0
    add_listeners: True
    remove_all_jobs: True

The config section is make up of the following items

  • Bots - How to configure one of more bots to load into the client
  • Renderer - The type of rendered to display the output to the user. For console this is basic text renderer
  • Storage - The configuration for controlling the storage options of the boc
  • Scheduler - If you are using asynchronous events then you configured the scheduler here
  • Email - A new addition post v3.6 which provides the abiity to send emails from your client

Some clients then have additional configuration items specific to them, these are:

Clone this wiki locally