|
1 |
| -# PronoteBOT |
| 1 | +<p align="center"> |
| 2 | + <a href="https://github.com/eythan/PronoteBOT"> |
| 3 | + <img src="https://urlr.me/WRzYT" alt="Logo" width="120" height="120"> |
| 4 | + </a> |
| 5 | + <h3 align="center">PronoteBOT</h1> |
| 6 | +</p> |
| 7 | + |
| 8 | + |
| 9 | +## Introduction |
| 10 | + |
| 11 | +PronoteBOT allows you to send absences and homework to different Discord channels via the [pronotepy](https://github.com/bain3/pronotepy) API. It is available to most schools in mainland France. |
| 12 | + |
| 13 | +## Dependencies |
| 14 | + |
| 15 | + - [Node.js](https://nodejs.org/en) |
| 16 | + - [python (3.12.6)](https://www.python.org/downloads/release/python-3126/) |
| 17 | + |
| 18 | + > [!WARNING] |
| 19 | +>Only python 3.12.6 works don't download a newer version |
| 20 | +
|
| 21 | +## Installation |
| 22 | + |
| 23 | +Clone repository with [git](https://git-scm.com/downloads) |
| 24 | + |
| 25 | +```bash |
| 26 | +git clone https://github.com/eythan/PronoteBOT |
| 27 | +``` |
| 28 | +Install Node.js dependencies |
| 29 | + |
| 30 | +```bash |
| 31 | +npm i |
| 32 | +``` |
| 33 | + |
| 34 | +Install Python dependencies |
| 35 | + |
| 36 | +```bash |
| 37 | +pip install pronotepy |
| 38 | +``` |
| 39 | + |
| 40 | +Complete config.json file |
| 41 | + |
| 42 | +```bash |
| 43 | +{ |
| 44 | + "pronoteURL": "URL of the Pronote portal", |
| 45 | + "username": "Your ENT username", |
| 46 | + "password": "Your ENT password", |
| 47 | + "ent": "Name of your ENT see complete list below", |
| 48 | + "local": "Local setting", |
| 49 | + "homeworkImageURL": "URL for an image related to homework", |
| 50 | + "absenceImageURL": "URL for an image related to absences", |
| 51 | + "absenceChannel": "ID of absence channel.", |
| 52 | + "homeworkChannel": "ID of homework channel", |
| 53 | + "token": "Token discord" |
| 54 | +} |
| 55 | +``` |
| 56 | + |
| 57 | +Example |
| 58 | + |
| 59 | +```bash |
| 60 | +{ |
| 61 | + "pronoteURL": "https://0310047h.index-education.net/pronote/eleve.html", |
| 62 | + "username": "t.dubois1", |
| 63 | + "password": "mdE365eyQK={C-6", |
| 64 | + "ent": "occitanie_toulouse_edu", |
| 65 | + "local": "fr-FR", |
| 66 | + "homeworkImageURL": "https://urlr.me/WRzYT", |
| 67 | + "absenceImageURL": "https://urlr.me/WRzYT", |
| 68 | + "absenceChannel": "1286403078169296977", |
| 69 | + "homeworkChannel": "1283497573302272040", |
| 70 | + "token": "SPt8W0_w2xFsg.u2yF1gXa7aZWmMPr93YsNPHv.t2g8gJiyZ597QAY9cnBP2" |
| 71 | +} |
| 72 | +``` |
| 73 | + |
| 74 | +Start the bot |
| 75 | + |
| 76 | +```bash |
| 77 | +node index.js |
| 78 | +``` |
| 79 | + |
| 80 | +## CAS / ENT |
| 81 | + |
| 82 | +**Académies :** |
| 83 | + |
| 84 | + - Académie d'**Orléans-Tours** (ENT : **ac_orleans_tours**) |
| 85 | + - Académie de **Poitiers** (ENT : **ac_poitiers**) |
| 86 | + - Académie de la **Réunion** (ENT : **ac_reunion**) |
| 87 | + - Académie de **Reims** (ENT : **ac_reims**) |
| 88 | + - Académie de **Rennes** (ENT : **ac_rennes**) |
| 89 | + - Académie de **Nice** et d'**Aix Marseille** (ENT : **atrium_sud**) |
| 90 | + - Académie de **Bordeaux** (ENT : **bordeaux**) |
| 91 | + - Académie de **Mayotte** (ENT : **ent_mayotte**) |
| 92 | + - Académie de **Normandie** (ENT : **l_normandie**) |
| 93 | + - Académie de **Guadeloupe** (ENT : **neoconnect_guadeloupe**) |
| 94 | + - Académie de **Montpellier** (ENT : **occitanie_montpellier**) |
| 95 | + - Académie de **Montpellier** (ENT : **occitanie_montpellier_educonnect**) |
| 96 | + - Académie de **Toulouse** (ENT : **occitanie_toulouse_edu**) |
| 97 | + - Académie de **Paris** (ENT : **paris_classe_numerique**) |
| 98 | + |
| 99 | +**Autres :** |
| 100 | + |
| 101 | + - Alpes-Maritimes (**Nice**) (ENT : **cas_agora06**) |
| 102 | + - Seine-Maritime (**Normandie**) (ENT : **cas_arsene76_edu**) |
| 103 | + - Loire (**Lyon**) (ENT : **cas_cybercolleges42_edu**) |
| 104 | + - Seine-Saint-Denis (**Créteil**) (ENT : **cas_seinesaintdenis_edu**) |
| 105 | + - Bourgogne-Franche-Compté (**Dijon**) (ENT : **eclat_bfc**) |
| 106 | + - Haute-Garonne (**Toulouse**) (ENT : **ecollege_haute_garonne_edu**) |
| 107 | + - Bouches-du-Rhône (**Aix Marseille**) (ENT : **ent_94**) |
| 108 | + - Auvergne-Rhône-Alpes (**Lyon**) (ENT : **ent_auvergnerhonealpe**) |
| 109 | + - Creuse (**Limoges**) (ENT : **ent_creuse**) |
| 110 | + - Creuse (**Limoges**) (ENT : **ent_creuse_educonnect**) |
| 111 | + - Loire-Atlantique (**Nantes**) (ENT : **ent_elyco**) |
| 112 | + - Essonne (**Versailles**) (ENT : **ent_essonne**) |
| 113 | + - Hauts-de-France (**Lille** et **Amiens**) (ENT : **ent_hdf**) |
| 114 | + - Somme (**Amiens**) (ENT : **ent_somme**) |
| 115 | + - Var (**Nice**) (ENT : **ent_var**) |
| 116 | + - Seine-et-Marne (**Créteil**) (ENT : **ent77**) |
| 117 | + - Yvelines (**Versailles**) (ENT : **ent_ecollege78**) |
| 118 | + - Somme (**Amiens**) (ENT : **extranet_colleges_somme**) |
| 119 | + - Île-de-France (**Paris**, **Versailles** et **Créteil**) (ENT : **ile_de_france**) |
| 120 | + - Métropole Grand Lyon (**Lyon**) (ENT : **laclasse_educonnect**) |
| 121 | + - Métropole Grand Lyon (**Lyon**) (ENT : **laclasse_lyon**) |
| 122 | + - Nouvelle-Aquitaine (**Bordeaux**, **Limoges** et **Poitiers**) (ENT : **lyceeconnecte_aquitaine**) |
| 123 | + - Nouvelle-Aquitaine (**Bordeaux**, **Limoges** et **Poitiers**) (ENT : **lyceeconnecte_edu**) |
| 124 | + - Région Grand Est (**Strasbourg**, **Nancy-Metz** et **Reims**) (ENT : **monbureaunumerique**) |
| 125 | + - Val-de-Marne (**Créteil**) (ENT : **val_de_marne**) |
| 126 | + - Val-d'Oise (**Versailles**) (ENT : **val_doise**) |
| 127 | + - France (**France**) (ENT : **cas_kosmos**) |
0 commit comments