Course Seat Availability Notifier

This repository hosts a set of Python scripts and a GitHub Actions workflow tailored to periodically monitor seat availability in various courses. In the event of an available seat, you will receive an email notification. The design is modular, ensuring ease of adding individualized logic for each course.

Table of Contents

1. Overview
2. How It Works
3. Requirements
4. Usage
5. Adding New Courses
6. Credits
7. Screenshots

Overview

The main.py script at the heart of this repository meticulously checks the seat availability of specific courses, as listed in COURSE_TO_DETECT. The GitHub Actions workflow is configured to trigger upon any push to the main branch and can also be manually initiated. Following the initial trigger, it is set to run at 5-minute intervals. In circumstances where a seat becomes available in any of the listed courses, the workflow is deliberately designed to fail. This intentional failure serves as a trigger for GitHub to send you an email notification. To utilize this feature, ensure that your GitHub settings are configured to notify you in the event of workflow failures.

How It Works

1. Environment Setup: The GitHub Actions workflow establishes a Python environment and proceeds to install all necessary dependencies.
2. Seat Availability Check: The main.py script is then executed to assess the seat availability for each course specified in COURSE_TO_DETECT. Each course is represented by its own Python script within the courses directory.
3. Notification Trigger: If an available seat is detected in any course, the script exits with a status code of 1. This exit code results in the failure of the GitHub Actions job, subsequently triggering a notification.
4. No Availability: In the absence of available seats, the script communicates the unavailability through a printed message and exits gracefully with a status code of 0, indicating successful execution of the process.

Requirements

• Python 3.x
• Required Python packages (listed in requirements.txt)

Usage

1. Clone the repository:

   git clone https://github.com/your-username/your-repository-name.git
   cd your-repository-name
   

2. (Optional) Add additional courses to the COURSE_TO_DETECT list in main.py.

3. Push your changes to the main branch to trigger the GitHub Actions workflow:

   git add .
   git commit -m "Add new courses"
   git push origin main
   

4. The GitHub Actions workflow will now run automatically every 5 minutes. You can also manually trigger it from the GitHub repository's Actions tab.

5. If a seat is available in any of the courses, the workflow will fail and you can receive an email notification. Make sure you have configured GitHub to notify you on workflow failures.

Adding New Courses

To add a new course for tracking:

1. Create a new Python script in the courses directory, following the template of the existing course scripts.
2. Add the course's class name to the COURSE_TO_DETECT list in main.py.
3. Make sure the course script includes the logic to check seat availability and return the proper message.

Credits

Authorship:

• Jingchao Zhong @perryzjc

Screenshots

1. GitHub Actions Workflow:

2. Notification Email:

3. Adding a New Course: