Skip to content

Latest commit

 

History

History
57 lines (49 loc) · 3.07 KB

README.md

File metadata and controls

57 lines (49 loc) · 3.07 KB
Raw

PantherBot

PantherBot is a WebSocket Application that takes advantage of Slack's RTM and Web API to interact with the channels that it is a part of.

Using PantherBot

PantherBot currently has a few commands available to use. These are broken up into action commands and logging commands. All action commands are prefaced with the "!" marker (ie. !coin). Logging commands are prefaced with the "$" marker (ie. $log). Some responses are hard coded to certain phrases (ie. Hey PantherBot).

Current list of action commands:

!help
!coin
!helloworld
!fortune
!catfact
!pugbomb <int>
!taskme
!flip/!rage/!unflip <Optional:String>

Current list of logging commands:

$log <true/false> <optional: list of channels>
$admin <reconnect/update>
$calendar add ; <Title> ; <Date in format YYYY-MM-DD> ; <Start time in format HH:mm> ; <End time in format HH:mm> ; <Description> ; <Location>

To use these commands, in any channel that PantherBot is both present in and may post, start your message with one of the above commands and fill in the arguments as necessary

PantherBot also responds to a few custom messages as well, currently set to:

Hey PantherBot
PantherBot ping
rip PantherBot

As well as messaging them a custom message upon joining the Slack team.

Installing Dependencies

PantherBot requires several python libraries to function. These can be easily installed with the setup.bat or setup.sh file. setup.sh should be run with elevated privileges to ensure dependencies install correctly (this is an issue for most unless you're using a virtualenv) (sudo sh setup.sh should be good enough). Likewise, pip may request your permission or a prompt if using the setup.bat file. If it fails, try using administrative privileges.

Setting up PantherBot

PantherBot is currently relatively easy to set up in your Slack team. Follow the instructions below and it'll be up and running in no time!

  1. Install Python 2.7 if not installed previously.
  2. Run setup.bat (for Windows) or setup.sh (for macOS/Linux) to install dependencies and create the necessary folders.
  3. Go to your Slack team settings and set up a bot configuration, be sure to give it some information, including a username! Copy the API token.
  4. In the secrets folder, make a file called slack_secret.txt that contains only your API token.
  5. Depending on your OS, run either start.bat (Windows) or start.sh (macOS and Linux).
  6. The bot should become active in the slack team. Invite the bot into the channels you would like it to monitor (using the /invite @username command), and off it goes surveying the world!
  7. If there are errors, consider re-running setup.bat or setup.sh in a higher privileged environment to be sure everything is installed properly.
  8. The bot is set up. If you want to edit anything (like the posting name or icon), edit the config folder files to edit things such as:
  • BOT_NAME, BOT_ICON_URL (in bot.txt)
  • SLACK, GOOGLECAL, LOGGING, GOOGLECALSECRET, NEWUSERGREETING, GREETING (in settings.txt)
  • ADMIN (in admin.txt)