BakaBot

BakaBot is a Discord bot and web scraper designed for the Czech online schooling system Bakaláři. Receive real-time updates on new grades, schedule changes, and more directly in your Discord server!

Features

• 📅 Schedule Notifications: Get real-time Discord notifications when your school schedule changes.
• 📚 Grade Alerts: Stay up to date with your latest grades, delivered directly to your Discord.
• ☀️ Daily Schedule Reminders: Receive notifications each morning with your schedule for the day.
• ⏰ Upcoming Lessons Alerts: Be notified about upcoming lessons and events.
• 🌐 Bakaláři Server Status: Monitor the current status of your Bakaláři server.
• 📆 Custom Schedule Requests: Use the /schedule command to fetch your schedule for any given day.

Usage examples

• 📅 Get immediate Discord notifications for any changes detected in your school schedule

  View changes presented in user-friendly HTML/CSS generated images using Pyppeteer

• 📚 Stay informed about your latest grades 💀

  Get instant updates on your grades with easy-to-read notifications.

>

• ☀️ Receive daily morning notifications about the day's schedule

  Start your day with a helpful reminder of your upcoming lessons.

• ⏰ Get notifed about the upcoming lessons

  Receive timely alerts for upcoming lessons to stay prepared.

• 🌐 Keep track of Bakaláři server's online status

  Monitor the server status to check if Bakaláři is online.

• 📆 Use the /schedule command to get the schedule for any specific day

  Easily fetch the schedule for any day with a simple command.

Instalation

1. Clone the repository:

   git clone https://github.com/Patai5/BakaBot.git
   cd BakaBot

2. Setup your .env file:

   Copy the example .env file and configure it with your Discord bot credentials.

   cp .env.example .env

   • Discord Token: How to get your Discord token
     • Don’t forget to enable all three Privileged Gateway Intents (found under the "Bot" settings).
   • Discord ID: How to get your Discord ID

3. Create a virtual environment (Optional but recommended)

   python -m venv env

4. Activate the virtual environment:

   • On Windows:

     env\Scripts\activate.bat

   • On macOS/Linux:

     source env/bin/activate

5. Install dependencies:

   pip install -e .

   (If you're contributing to the project, install development dependencies)

   pip install -e .[dev]

6. Install Playwright:

   playwright install

7. Start the bot:

   python -m src.main

8. Setup the bot: Once the bot is running, use the /setup command in your Discord server to configure it.

Docker

To run the bot using Docker, execute:

docker-compose up --build -d