This repository has been archived on 2025-04-11. You can view files and clone it, but cannot push or open issues or pull requests.
slack-bot-testing/README.md

25 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2019-06-27 20:02:08 -05:00
# UP Hype Bot
A Slack bot written in Python to gets HYPED on that Unified Platform
2019-06-27 20:12:03 -05:00
## Usage
Firstly, this bot was written using BASH so I'm unsure how well this will run on Windows. I'm currently running it on a Google Cloud Platform free tier VPS.
Clone this repo, then make sure you have the `slackclient` module installed in your python environment.
You will need an API token from Slack, you can learn that and more on how to set up a bot from this documentation: https://github.com/slackapi/python-slackclient/blob/master/tutorial/01-creating-the-slack-app.md
Once you have set up and installed your app/bot, you can run it by typing:
`./runner.sh`
The bot should automatically put itself in the background, currently the only way to kill it is either to execute a `kill` command or use something like `htop` to kill the process.
## Features
### CF Functionality
2019-06-27 20:02:08 -05:00
Simply make any post in the chat that contains a C-word followed immediately with an F-word and the bot will quickly and efficiently remind you of what CF stands for.
This functionality ignores cases and can optionally be triggered with "CF"
## Future Work
### UP! Emoji Injection
### CF Quote Repeater