a slack bot doing simple script jobs
a slack bot can execute commands by slack chat room (
@bot_name: command
), wherein these commands are specified in a folder.
start a bot
antbot -c
to copy the config file to current folder- add your bot key into config file
antbot
to run the bot
use in slack
@bot_name: help
to show the command can be executed by the bot@bot_name: command
to execute that command
help
antbot -h
for help
please set up at least following parameters in config file as ant.conf (in working folder or in ~/.config); or set up as environment parameters:
BOT_ID
orBOT_NAME
SLACK_BOT_TOKEN
(api key provided by slack)SCRIPTS_FOLDER
(script job you want to provide, default is current folder)DEFAULT_SCRIPT
(handle the unknow command)
Following parameters can be set in config file:
OUTPUT
- return scripts execution output back to slackENCODING
- specify the encoding of stdoutDEBUG_CHANNEL
- specify the channel always show the execution outputMENTION
- Mention back the original caller (Thanks imrobinized@github)
- python 3.5+
- slackclient
Version 0.1.4, 0.1.5, 0.1.6
- change use nameko for microservice
- use
JOBS_FOLDER
to process regular jobs - please specify the
JOBS_CHANNEL
for the regulat jobs output
Version 0.1.3
- if @botname at the head of chat message, then trigger command
- use
DEFAULT_SCRIPT
to handle unspecific command
Version 0.1.0, 0.1.1, 0.1.2
- mention the caller (optional), set
MENTION=True
in config file - remove the mention in debug chanel (0.1.1)
- mention with orignal command
Version 0.0.9
- add debug channel
Version 0.0.8
- Case sensitive
Version 0.0.7
- Passing arguments to commands
Version 0.0.6
- fix the requirement
Version 0.0.4
- fix the bug on STDOUT encoding
- Parameter patching rull ./ant.conf > ~/.ant.conf > environment parameters
Version 0.0.3
- command line document
- copy config example
- show command execution output to slack (optional)
Version 0.0.1
- basic bot
Copyright (c) 2016 Antonio Yang (yanganto) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.