canvas-discord-bot

Canvas Discord Bot

This is a discord bot that gets information about courses and announcements from Canvas API and sends this information in a discord channel.

Report Bug · Request Feature

About The Project
- Built With
Getting Started
Commands
Make Your Own Command?
Contributing
License
Contact
Acknowledgements

About The Project

We are a group of students studying at Gothenburg University who decided that we wanted to build a bridge between Canvas LMS and Discord. The result is a bot that can recieve and post announcements made by, for example, teachers in a Discord channel.

Built With

Getting Started

Below you will find the steps to get started with the bot.

Prerequisites

Download the latest version of Python
Create a discord bot and invite it to your discord channel
Create a Canvas API access token as an admin or regular user (if you domain permits it).

Installation

Clone the repository

git clone https://github.com/Dedas/canvas-discord-bot

Navigate into your cloned folder

cd "Drive:/folder/folder/canvas-discord-bot"

Install the following modules:

pip install requests
pip install environs
pip install apscheduler
pip install discord
pip install BeautifulSoup4
pip install lxml

Usage

To use the bot you need to fill in some parameters in the .env file.

Rename the .env.example file to .env

In the .env file, replace the text with your parameters

Make sure that the Canvas Token has access to all the availible courses!

DISCORD_TOKEN='https://discord.com/developers/applications'
CANVAS_TOKEN='YOUR CANVAS TOKEN'
CANVAS_DOMAIN='YOUR CANVAS DOMAIN'
DEFAULT_CHANNEL_ID='YOUR DISCORD DEFAULT_CHANNEL_ID'

Run the bot
```
python bot.py
```
With debug messages on:
```
python bot.py -d
```

Commands

.courses - List all the courses that the bot has access to.
.subscribe <course_id> <channel_id> - Subscribing to a course and recieve announcements from that course in a specific channel.
.unsubscribe <course_id> - Unsubscribe to a course.

Options in "config.json"

Discord specific

"discord_command_prefix" : "<prefix>" - The prefix that will be used to communicate with the bot in Discord. Default prefix "!"

Internal scheduler loops

"monitor_scheduler_interval" : <seconds> - Interval of loop that fetches data from Canvas in X seconds.
"announcement_scheduler_interval" : <seconds> - Interval of loop that sends announcements to Canvas in X seconds.