tgrkzus / uqcsbot-1

UQCSbot: our friendly little Slack bot

uqcsbot

uqcsbot is a chat bot built in python for use on our UQCS Slack Team.

Setting up the bot

Run python3 setup.py install

Running the bot in a local development environment

Run python3 -m uqcsbot --local

Note: If you're wanting to test/interact with Slack-specific features (e.g. reactions, channels), you must be running the bot with Slack (See following sections).

Running the bot in the communal dev Slack team

1. Ensure you've joined the uqcstesting Slack team
2. Run python3 -m uqcsbot --dev

If a bot was available, it will now be running on uqcstesting.

Running the bot in a custom Slack team

1. Create a Slack workspace
2. Run python3 setup.py install
3. Create a new Slack app
4. Add a bot user to your app
5. Install your app to your workspace. Install App > Install App to Workspace
6. Copy the Bot User OAuth Access Token and set it as an environment variable under SLACK_BOT_TOKEN
7. Go to Basic Information, copy your Verification Token and set it as an environment variable under SLACK_VERIFICATION_TOKEN
8. Run python3 -m uqcsbot

The bot will now be running on your custom Slack.