Beach Buddy

Python Discord bot that displays CSULB course information. Get notifications when seats & sections open.

The data displayed by the bot updates every morning at 5:03 AM - 5:04 AM. This is when the CSULB schedule of classes updates. Currently, real time updates are a work in progress.

See Gallery below to see examples of bot usage.

Gallery

/search command:

/search of CECS 329 in Fall 2024 with opened_only set to False

Set channel to where notifications are sent:

Beach Buddy updating its' data on courses every morning:

Getting Started

Prerequisites

• Python 3.11+

• All dependencies within requirements.txt

Installation

Windows:

1. Download Python and set it to PATH during installation.
2. Clone this repository
3. Create a file called config.py in the project root folder
   • Set variable BOT_TOKEN to your bot's token. See next section for directions on how to set up your own Discord bot.
4. Create a notif.txtfile
5. Download requirements using:

   pip install -r /path/to/requirements.txt

6. Run the scrape_subjects.py code to populate two CSV files holding all course information. The CSV files will be located in the seasons folder.

Discord Bot Setup

1. Visit the Discord Developer Portal to create your Discord Bot
2. Select the applications tab, then click on New Application

3. Choose a name, agree to the terms and services (only if you agree), then select create.
4. Go to the Bot tab and select the Reset Token button. Copy the token and paste it into your config.py file.

5. Ensure these permissions match.

6. Invite the Discord Bot to your server with the administrator box marked:

Updating Beach Buddy

We don't provide release versions. To get the latest version, simply perform git pull.

Authors

Angie Tran & Diego Cid

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• README.md inspiration from KOOKZ