OpenCourseAPI / OpenCourseBot

A handy discord bot for college-related information such as classes, professors, and statistics ✨

OpenCourseBot

This is a handy discord bot for college-related functionality such as information about classes, professors, and general statistics.

Features

• Search college class data such as subjects, courses, classes, and seats (powered by OpenCourseAPI)
• Search professors, including ratings
• Search class grade distributions
• Search ASSIST transfer reports
• Search UC Transfer Statistics

Development

The commands and features of the bot are split accross two separate bots, which run on Python 3+ and Node.js respectively.

Setup

Node.js

Install Node.js v12+ and npm, and then install packages with:

npm install

Python

Install Python 3.7+ and poetry, and then install packages with:

poetry install

Configuration

Create a file called .env with the following content:

BOT_TOKEN=<discord bot token>
BOT_OWNERS=<comma separated Discord user IDs>
BOT_PREFIX=<command prefix>

Start

Run the following command to start both bots:

poetry shell
npm start

Lint

Use the following commands to lint the code:

Node.js

npm run lint # only check
npm run lint:fix # check and fix

Python

poetry shell
black ./bots/py # check and fix errors

Contribute

All contributions are welcome! Feel free to get started by opening an issue or pull request.

Core Team

• Madhav Varshney
• David Tso

License

MIT License