REST API based bot for Rocket.Chat
Project description
REST API based bot for Rocket.Chat
Install
pip install RocketChatAPIBot
Usage
Create new bot
import os
from RocketChatBot import RocketChatBot
botname = os.environ['BOTNAME']
botpassword = os.environ['BOTPASSWORD']
server_url = os.environ['BOT_URL']
bot = RocketChatBot(botname, botpassword, server_url)
Send message to channel
bot.send_message('starting bot...', channel_id='GENERAL')
Direct message handler
Gets triggered when sentence starts with the botname like '@botname echo hello'
def greet(msg, user, channel_id):
bot.send_message('hello @' + user, channel_id)
bot.add_dm_handler(['hey', 'hello', ], greet)
Receives a list of keywords to trigger the command and the method to execute. The method should receive as parameters always msg as the message, user and channel_id
Auto answer handler
Gets triggered with the mention of keywords. Only made to respond with simple text, no functions.
bot.add_auto_answer(['good news', 'i have good news', ], ['hell yeah!', 'tell me, tell me!', 'you are already good news ;)', ])
Direct answer handler
Gets triggered when sentence starts with the name of the bot and keywords are in the sentence like '@botname who are you?'
bot.add_direct_answer(['who are you?', 'what is your name?', ], ['I am botname', ])
Handle unknow commands
bot.unknow_command = ['I do not know what you want me to do...', 'I\'m almost sure I\'m not programmed to do that', 'I have no idea how to do that so here is a hug :hugging:']
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for RocketChatAPIBot-0.1.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2452ecd169394353e7047e89d8fb11627517c98f066095238b6d344459f641da |
|
MD5 | 9a4e27062f89abe7b89ceda8045c184c |
|
BLAKE2b-256 | a23c0f019e47e82139b3be95bfb1cd256e7d1a8fb018fbd9e2a4cb345d91283c |