janek/mostr-zulip-bot
1
0
Fork 0
Code Issues Pull requests Releases Activity
mostr-zulip-bot/zulip_bots/zulip_bots/bots/baremetrics/doc.md
Viraat Chandra d8c6cb7c0a interactive bots: Create Baremetrics bot.
2017-12-29 11:50:33 +01:00

1.4 KiB
Raw Blame History

Baremetrics bot

The Baremetrics bot is a Zulip bot that gives updates about customer behavior, financial performance, and analytics for an organization using the Baremetrics API.

To use the Baremetrics bot, you can simply call it with @<botname> followed by a command, like so:

@Baremetrics help

Setup

Before usage, you will need to configure the bot by putting the value of the <api_key> in the config file. To do this, follow the given steps:

  1. Login at Baremetrics Console.
  2. Note the Live API Key.
  3. Open up zulip_bots/bots/baremetrics/baremetrics.conf in an editor and change the value of the <api_key> attribute to the noted Live API Key.

Developer Notes

Be sure to add the command and its description to their respective lists (named commands and descriptions) so that it can be displayed with the other available commands using @<botname> list-commands. Also modify the test_list_commands_command in test_baremetrics.py.

Links

Usage

@Baremetrics list-commands - This command gives a list of all available commands along with short short descriptions.

Example: