Skip to content

Awakno/PronoteNotifier

Repository files navigation

Pronote Notifier

Pronote Notifier is a Python script that periodically checks for new grades on Pronote and sends notifications to a Discord channel using webhooks.

This project is open source, so you can create a Pull request for new functionality

Requirements

  • Python 3.8+
  • discord_webhook
  • pronotepy
  • colorama
  • requests

Installation

  1. Clone the repository:

    git clone https://github.com/Awakno/PronoteNotifier.git
    cd PronoteNotifier
  2. Install the required packages:

    pip install -r requirements.txt
  3. Create a .env file based on the .env.example file and fill in your Pronote credentials and Discord webhook URL:

    cp .env.example .env
  4. Edit the .env file with your credentials and webhook URLs:

    # Crendentials for the pronote account
    PRONOTE_URL="https://your-pronote-url"
    PRONOTE_USERNAME="your-username"
    PRONOTE_PASSWORD="your-password"
    
    # Webhook
    DISCORD_WEBHOOK_URL="your-discord-webhook-url"
    CUSTOM_WEBHOOK_URL="your-custom-webhook-url"
    CUSTOM_WEBHOOK_PASS="your-custom-webhook-pass"
    
    # Telegram (optional)
    TELEGRAM_BOT_TOKEN="your-bot-token"
    TELEGRAM_CHAT_ID="your-chat-id"
    
    # Debug (optional)
    DEBUG=True
    
    # Optional: limit EDT fetch horizon (default 14 days)
    PRONOTE_EDT_DAYS=14

Usage

Run the script:

python main.py

Docker

Build & run with Docker Compose (uses .env for configuration):

docker compose up --build

Or plain Docker:

docker build -t pronote-notifier .
docker run --rm --env-file .env pronote-notifier

Optional: run a quick configuration check before starting (verifies env keys and imports):

python scripts/health_check.py

Todo

Add planning change notification: 🟢

Add canceled / absent teacher notification: 🟢

Add HomeWorks notification : 🟢

Discussion and information notification : 🟢

Add grade notification : 🟢

Enjoy ⭐

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published