Moodle Grades Scraper is a simple tool to be notified of new grades on Moodle 💯.
- E-mail alerting 📫
- Discord notifications (webhook) 🎤
- MariaDB storage 💾
- Running with Docker and Docker Compose 🐳
- Written in Python 3 🐍
Before using this project, ensure that the following requirements are met:
- Docker and Docker Compose need to be installed
- Even though we do not recommend Moodle Grades Scraper users to run the application from source, you may need to run from source for testing purposes or to enjoy the latest feature that is not released yet. To do so, make sure ✔️ :
- Python 3 (tested with v3.9.12) is installed on your system
- MariaDB (tested with v10.4) is installed on your system
To install Moodle Grades Scraper with Docker and Docker Compose, follow these steps:
- Clone the project
git clone https://github.com/Andreaj42/Moodle-Grades-Scraper.git
- Go to the project's directory
cd Moodle-Grades-Scraper
- Fill the .env file
vi .env
- Run the docker-compose.yaml
docker compose up -d
To install Moodle Grades Scraper from source, follow these steps:
- Clone the project
git clone https://github.com/Andreaj42/Moodle-Grades-Scraper.git
- Go to the project's directory
cd Moodle-Grades-Scraper
- Create a Python virtual environment
python -m venv _venv
- Activate the virtual environment
source _venv/bin/activate
- Set the variables of the .env file in your system
export VARIABLE_NAME=VALUE
- Install the dependencies with pip
pip install -e .
- Start the application
python application/main.py
| Variable | Description |
|---|---|
| MOOTSE_URL | Moodle URL (i.e: https://my-moodle.org/) |
| MOOTSE_USERNAME | Moodle username |
| MOOTSE_PASSWORD | Moodle password |
| MAIL_USERNAME | SMTP username |
| MAIL_PASSWORD | SMTP password |
| MAIL_SERVER | SMTP server |
| MAIL_PORT | SMTP port |
| MAIL_RECIPIENTS | Optional - Mail recipients separated by ';' (i.e: "user1@mail.org;user2@mail.org"). |
| DISCORD_WEBHOOK_URL | Optional - Discord webhook URL. |
| DB_HOST | MariaDB host |
| DB_USER | MariaDB user |
| DB_PASSWORD | MariaDB password |
| DB_PORT | MariaDB port |
| PROMO | The name of your promotion, in a single word (i.e: myWonderfulPromo) |
| MYSQL_ROOT_PASSWORD | Optional in source mode - MariaDB password when running with Docker Compose |
| SCAN_INTERVAL | Scan interval in seconds (i.e: 120 for 2 minutes) |
| MOOTSE_MASTER_URL | Optional - Mootse Master URL (i.e: http://mootse-master.local) |
Simply open an issue in this repository.
Moodle Grades Scraper is not part of Moodle.