Skip to content

README.md

Latest commit

 

History

History
101 lines (65 loc) · 1.68 KB

README.md

File metadata and controls

101 lines (65 loc) · 1.68 KB

EcoleDirecte Python Client

A lightweight Python wrapper for the EcoleDirecte API. This library allows students to authenticate and retrieve data such as timetable, homework, grades, and school life information.

Overview

This project provides a simple Python interface to interact with the EcoleDirecte API.

It handles:

  • Authentication
  • Token management
  • Data retrieval from multiple endpoints

The goal of this project is to simplify access to school data using clean and reusable Python code.

Features

  • Secure login using username and password
  • Retrieve weekly timetable
  • Retrieve homework
  • Retrieve grades
  • Retrieve school life information
  • Retrieve cloud documents

Tech Stack

  • Python 3
  • requests library
  • JSON handling
  • Object-Oriented Programming

Installation

Clone the repository:

git clone https://github.com/your-username/ecoledirecte-client.git
cd ecoledirecte-client

Install dependencies:

pip install requests

Usage

from ecoledirect import EcoleDirect

client = EcoleDirect("username", "password")

timetable = client.getWT()
homework = client.getHW()
grades = client.getNotes()

Project Structure

ecoledirect.py   # Main API client

Future Improvements

  • Proper exception handling instead of print statements
  • Add type hints everywhere
  • Add unit tests
  • Improve request payload formatting
  • Package the project for PyPI

Disclaimer

This project is not officially affiliated with EcoleDirecte. It is an independent implementation for educational purposes.

Author

Jules GRIVOT PELISSON GitHub: https://github.com/Jules-GP