pronotepy Python API Wrapper

PRONOTE changes object IDs every session. While old objects (like pronotepy.Lesson) retain their data (description, subject), calling methods that request new data from PRONOTE will raise a pronotepy.ExpiredObject exception.

To build long-running bots, use client.session_check() to detect if the connection needs refreshing. If it returns True, you must re-fetch your objects (e.g., re-calling client.lessons(...)) to obtain renewed instances.

import pronotepy
import datetime
from time import sleep

client = pronotepy.Client('https://demo.index-education.net/pronote/eleve.html', 
                          username='demonstration', 
                          password='pronotevs')

if not client.logged_in:
    exit()

# Initial object fetch
lesson = client.lessons(client.start_day + datetime.timedelta(days=1))[0]

while True:
    # Check if session expired and refresh if necessary
    if client.session_check():
        # Re-fetch the object to get a renewed instance
        lesson = client.lessons(client.start_day + datetime.timedelta(days=1))[0]
        print("Session reinitialised and object renewed.")

    print(lesson.content)
    sleep(7200)

Pronotepy provides three specialized client classes depending on the type of user account you are accessing. All clients automatically attempt to log in upon instantiation.

• Client: Use this for standard student accounts.
• ParentClient: Use this for parent accounts. It includes the additional method set_child to switch between different children linked to the account.
• VieScolaireClient: Use this for 'vie scolaire' (school life) administrative accounts, which provide access to a different set of resources.

All clients inherit from ClientBase, which handles the underlying login logic and raw communication with the PRONOTE server.

import pronotepy

# For a student
client = pronotepy.Client(url, username='...', password='...')

# For a parent
parent_client = pronotepy.ParentClient(url, username='...', password='...')
parent_client.set_child('child_id')

# For school administration
admin_client = pronotepy.VieScolaireClient(url, username='...', password='...')

You can initialize a Client directly with a username and password.

Requirements:

• The URL must be a direct link to your PRONOTE instance (e.g., ending in eleve.html or parent.html) and must not include query parameters.
• If you are logging in through an ENT (Environnement Numérique de Travail), you must pass an ENT-specific function (e.g., ac_reunion from pronotepy.ent) to the ent parameter to fetch cookies correctly.

High Security Accounts: If your account requires a PIN or recognizes devices, provide account_pin, device_name, and client_identifier. Once logged in, you can retrieve the client_identifier from the client instance to use in future sessions.

import pronotepy
from pronotepy.ent import ac_reunion

# Standard login via ENT
client = pronotepy.Client(
    'https://demo.index-education.net/pronote/eleve.html',
    username='demonstration',
    password='pronotevs',
    ent=ac_reunion
)

# Login for accounts with higher security (PIN/Device recognition)
client = pronotepy.Client(
    'https://demo.index-education.net/pronote/eleve.html',
    username='demonstration',
    password='pronotevs',
    account_pin="1111",
    device_name="pronotepy",
    client_identifier=None
)

# Retrieve identifier to use for future recognized device logins
identifier = client.client_identifier

Pronotepy objects can be converted to Python dictionaries using the .to_dict() method. This is useful for JSON serialization.

Because the built-in json module cannot serialize datetime, date, or timedelta objects, you must provide a custom default serializer function when calling json.dumps().

import pronotepy
import datetime
import json

client = pronotepy.Client('https://demo.index-education.net/pronote/eleve.html', 
                          username='demonstration', 
                          password='pronotevs')

def serializer(obj):
    if isinstance(obj, (datetime.datetime, datetime.date, datetime.timedelta)):
        return str(obj)
    raise TypeError(f"Type {type(obj)} not serializable")

for period in client.periods:
    # include_properties=True ensures properties like .grades are included
    # exclude allows you to skip specific keys like 'punishments'
    serialized = period.to_dict(include_properties=True, exclude={"punishments", })
    print(json.dumps(serialized, default=serializer, indent=2))