Skip to content
This repository was archived by the owner on Jan 3, 2024. It is now read-only.

Commit b36069b

Browse files
maelgangloffmaelgangloff
committed
docs(README): update documentation
1 parent 5a32be2 commit b36069b

25 files changed

Lines changed: 145 additions & 103 deletions

‎.npmignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
docs/
12
node_modules/
23
.idea
34
src

‎README.md‎

Lines changed: 48 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,63 @@
1-
<a name="Kdecole"></a>
1+
# kdecole-api
22

3-
## Kdecole
4-
Support non-officiel de l'API Kdecole (Mon Bureau Numérique, Skolengo, etc.)
3+
[![view on npm](http://img.shields.io/npm/v/kdecole-api.svg?style=flat-square)](https://www.npmjs.org/package/kdecole-api)
4+
![GitHub CI](https://github.com/maelgangloff/kdecole-api/actions/workflows/CI.yml/badge.svg)
5+
[![Discord](https://img.shields.io/discord/1095829734211977276?label=Discord&style=flat-square)](https://discord.gg/9u69mxsFT6)
6+
[![npm](https://img.shields.io/npm/dm/kdecole-api?style=flat-square)](https://npm-stat.com/charts.html?package=kdecole-api)
7+
8+
Support non officiel de l'API Kdecole (Mon Bureau Numérique, Skolengo, etc.).
59

610
Ce module permet de récupérer les données de l'ENT de manière automatique. De plus, certaines fonctions implémentées permettent de prétraiter les données (conversion de l'emploi du temps au format iCalendar, export du relevé de notes au format CSV par exemple).
711

12+
Cette librairie est destinée à être dépréciée au profit de [scolengo-api](https://github.com/maelgangloff/scolengo-api) dans l'éventualité où l'accès à l'ancienne API est définitivement clos.
13+
14+
Pour participer et se tenir informé, **rejoins le serveur Discord: https://discord.gg/9u69mxsFT6**
15+
16+
17+
## Remarques importantes:
18+
- Il est clairement mentionné que cette librairie est n'est pas officielle.
19+
- Ce module n'est pas une contrefaçon car il n'existe pas de module similaire édité officiellement.
20+
- Les utilisateurs ne peuvent accéder qu'à leurs propres données. Ils sont soumis au même processus d'authentification que celui implémenté dans l'application.
21+
- Les données des utilisateurs ne sont pas davantage exposées puisqu'un utilisateur ne peut accéder qu'à ses propres données. Personne n'a le contrôle sur cette limitation qui est inhérente au fonctionnement de l'API des serveurs de Skolengo.
22+
- Cette librairie ne se suffit pas à elle-même pour fonctionner. Il est nécessaire de l'importer dans un projet et l'utilisateur est le seul responsable de son code et des éventuelles conséquences.
23+
- Tout utilisateur de cette librairie a *a priori* lu l'entièreté du fichier de licence GPLv3 disponible publiquement [LICENSE](https://github.com/maelgangloff/kdecole-api/blob/master/LICENSE) ainsi que de ce présent fichier de présentation.
24+
- Tout utilisateur de cette librairie a *a priori* lu l'entièreté du code de ce projet avant toute utilisation.
25+
- Eu égard l'ensemble de ces remarques, les contributeurs et *a fortiori* l'auteur du projet ne peuvent être tenus comme responsables de tout dommage potentiel.
26+
827
L'accès à l'API requiert une en-tête (header) avec la version de l'application en cours d'utilisation.
928

1029
Le terme "code" ou "password" ne réfère pas ici à votre mot de passe, mais à un code temporaire généré par votre ENT (dans paramètres > application mobile). C'est comme cela que fonctionne l'authentification à l'API.
1130

12-
Les versions à utiliser lors de la création de l'instance `Kdecole` sont données ci-dessous.
13-
14-
| Nom de l'ENT | Version | URL de l'API |
15-
|:-----------------------------:|:-------:|---------------------------------------------------------|
16-
| Mon Bureau Numérique | 3.7.14 | https://mobilite.monbureaunumerique.fr/mobilite |
17-
| Mon ENT Occitanie | 3.7.14 | https://mobilite.mon-ent-occitanie.fr/mobilite |
18-
| Arsène 76 | 3.7.14 | https://mobilite.arsene76.fr/mobilite |
19-
| ENT27 | 3.7.14 | https://mobilite.ent27.fr/mobilite |
20-
| ENT Creuse | 3.7.14 | https://mobilite.entcreuse.fr/mobilite |
21-
| ENT Auvergne-Rhône-Alpes | 3.7.14 | https://mobilite.ent.auvergnerhonealpes.fr/mobilite |
22-
| Agora 06 | 3.7.14 | https://mobilite.agora06.fr/mobilite |
23-
| CyberCollèges 42 | 3.7.14 | https://mobilite.cybercolleges42.fr/mobilite |
24-
| eCollège 31 Haute-Garonne | 3.7.14 | https://mobilite.ecollege.haute-garonne.fr/mobilite |
25-
| Mon collège en Val d'Oise | 3.7.14 | https://mobilite.moncollege.valdoise.fr/mobilite |
26-
| Webcollège Seine-Saint-Denis | 3.7.14 | https://mobilite.webcollege.seinesaintdenis.fr/mobilite |
27-
| Eclat-BFC | 3.7.14 | https://mobilite.eclat-bfc.fr/mobilite |
28-
| @ucollège84 | 3.7.14 | https://mobilite.aucollege84.vaucluse.fr/mobilite |
29-
| ENT Val de Marne | 3.7.14 | https://mobilite.entvaldemarne.skolengo.com/mobilite |
30-
| Skolengo Demo | 3.7.14 | https://mobilite.demo.skolengo.com/mobilite |
31-
| Skolengo | 3.7.14 | https://mobilite.skolengo.com/mobilite |
32-
| Kosmos Éducation (aefe, etc.) | 3.7.14 | https://mobilite.kosmoseducation.com/mobilite |
33-
| Skolengo formation | 3.7.14 | https://mobilite.formation.skolengo.com/mobilite |
34-
| Schulportal Ostbelgien | 3.7.14 | https://mobilite.schulen.be/mobilite |
35-
36-
Une autre méthode pour obtenir un token est d'utiliser la ligne de commande.
37-
31+
## Liste des ENT supportés :
32+
| Nom usuel de l'ENT | Identifiant interne librairie | URL de l'API mobilité |
33+
|------------------------------|------------------------------------|-----------------------------------------------------------|
34+
| Mon Bureau Numérique | PROD_MON_BUREAU_NUMERIQUE | https://mobilite.monbureaunumerique.fr/mobilite |
35+
| Mon ENT Occitanie | PROD_MON_ENT_OCCITANIE | https://mobilite.mon-ent-occitanie.fr/mobilite |
36+
| Arsène 76 | PROD_ARSENE76 | https://mobilite.arsene76.fr/mobilite |
37+
| ENT27 | PROD_ENT27 | https://mobilite.ent27.fr/mobilite |
38+
| ENT Creuse | PROD_ENTCREUSE | https://mobilite.entcreuse.fr/mobilite |
39+
| ENT Auvergne-Rhône-Alpes | PROD_AUVERGNERHONEALPES | https://mobilite.ent.auvergnerhonealpes.fr/mobilite |
40+
| Agora 06 | PROD_AGORA06 | https://mobilite.agora06.fr/mobilite |
41+
| CyberCollèges 42 | PROD_CYBERCOLLEGES42 | https://mobilite.cybercolleges42.fr/mobilite |
42+
| eCollège 31 Haute-Garonne | PROD_ECOLLEGE_HAUTE_GARONNE | https://mobilite.ecollege.haute-garonne.fr/mobilite |
43+
| Mon collège en Val d'Oise | PROD_MONCOLLEGE_VALDOISE | https://mobilite.moncollege.valdoise.fr/mobilite |
44+
| Webcollège Seine-Saint-Denis | PROD_WEBCOLLEGE_SEINESAINTDENIS | https://mobilite.webcollege.seinesaintdenis.fr/mobilite |
45+
| Eclat-BFC | PROD_ECLAT_BFC | https://mobilite.eclat-bfc.fr/mobilite |
46+
| @ucollège84 | PROD_AUCOLLEGE84_VAUCLUSE | https://mobilite.aucollege84.vaucluse.fr/mobilite |
47+
| ENT Val de Marne | PROD_ENT_VAL_DE_MARNE | https://mobilite.entvaldemarne.skolengo.com/mobilite |
48+
| Skolengo | PROD_SKOLENGO | https://mobilite.skolengo.com/mobilite |
49+
| Kosmos Éducation | PROD_KOSMOS_EDUCATION | https://mobilite.kosmoseducation.com/mobilite |
50+
| Skolengo-Collèges et Lycées | PROD_KOSMOS_EDUCATION_PDL | https://mobilite.pdl.kosmoseducation.com/mobilite |
51+
| Schulportal Ostbelgien | PROD_SCHULPORTAL_OSTBELGIEN | https://mobilite.schulen.be/mobilite |
52+
53+
Une autre méthode pour obtenir un token est d'utiliser la ligne de commande:
3854
```shell
3955
npx kdecole-api -u USERNAME -p CODE --ent PROD_MON_BUREAU_NUMERIQUE
4056
```
4157

58+
<a name="Kdecole"></a>
59+
60+
## Kdecole
4261
**Kind**: global class
4362

4463
* [Kdecole](#Kdecole)

‎bin/kdecole-api‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env node
22
const yargs = require('yargs')
3-
const { Kdecole, ApiVersion, ApiUrl } = require('../dist/Kdecole.js')
3+
const { Kdecole, ApiVersion, ApiUrl } = require('../dist/index.js')
44

55
const {u, p, ent} = yargs
66
.usage('Usage: -u <username> -p <uniquePassword> -e <ENT>')

‎docs/README.hbs‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# kdecole-api
2+
3+
[![view on npm](http://img.shields.io/npm/v/kdecole-api.svg?style=flat-square)](https://www.npmjs.org/package/kdecole-api)
4+
![GitHub CI](https://github.com/maelgangloff/kdecole-api/actions/workflows/CI.yml/badge.svg)
5+
[![Discord](https://img.shields.io/discord/1095829734211977276?label=Discord&style=flat-square)](https://discord.gg/9u69mxsFT6)
6+
[![npm](https://img.shields.io/npm/dm/kdecole-api?style=flat-square)](https://npm-stat.com/charts.html?package=kdecole-api)
7+
8+
Support non officiel de l'API Kdecole (Mon Bureau Numérique, Skolengo, etc.).
9+
10+
Ce module permet de récupérer les données de l'ENT de manière automatique. De plus, certaines fonctions implémentées permettent de prétraiter les données (conversion de l'emploi du temps au format iCalendar, export du relevé de notes au format CSV par exemple).
11+
12+
Cette librairie est destinée à être dépréciée au profit de [scolengo-api](https://github.com/maelgangloff/scolengo-api) dans l'éventualité où l'accès à l'ancienne API est définitivement clos.
13+
14+
Pour participer et se tenir informé, **rejoins le serveur Discord: https://discord.gg/9u69mxsFT6**
15+
16+
17+
## Remarques importantes:
18+
- Il est clairement mentionné que cette librairie est n'est pas officielle.
19+
- Ce module n'est pas une contrefaçon car il n'existe pas de module similaire édité officiellement.
20+
- Les utilisateurs ne peuvent accéder qu'à leurs propres données. Ils sont soumis au même processus d'authentification que celui implémenté dans l'application.
21+
- Les données des utilisateurs ne sont pas davantage exposées puisqu'un utilisateur ne peut accéder qu'à ses propres données. Personne n'a le contrôle sur cette limitation qui est inhérente au fonctionnement de l'API des serveurs de Skolengo.
22+
- Cette librairie ne se suffit pas à elle-même pour fonctionner. Il est nécessaire de l'importer dans un projet et l'utilisateur est le seul responsable de son code et des éventuelles conséquences.
23+
- Tout utilisateur de cette librairie a *a priori* lu l'entièreté du fichier de licence GPLv3 disponible publiquement [LICENSE](https://github.com/maelgangloff/kdecole-api/blob/master/LICENSE) ainsi que de ce présent fichier de présentation.
24+
- Tout utilisateur de cette librairie a *a priori* lu l'entièreté du code de ce projet avant toute utilisation.
25+
- Eu égard l'ensemble de ces remarques, les contributeurs et *a fortiori* l'auteur du projet ne peuvent être tenus comme responsables de tout dommage potentiel.
26+
27+
L'accès à l'API requiert une en-tête (header) avec la version de l'application en cours d'utilisation.
28+
29+
Le terme "code" ou "password" ne réfère pas ici à votre mot de passe, mais à un code temporaire généré par votre ENT (dans paramètres > application mobile). C'est comme cela que fonctionne l'authentification à l'API.
30+
31+
## Liste des ENT supportés :
32+
| Nom usuel de l'ENT | Identifiant interne librairie | URL de l'API mobilité |
33+
|------------------------------|------------------------------------|-----------------------------------------------------------|
34+
| Mon Bureau Numérique | PROD_MON_BUREAU_NUMERIQUE | https://mobilite.monbureaunumerique.fr/mobilite |
35+
| Mon ENT Occitanie | PROD_MON_ENT_OCCITANIE | https://mobilite.mon-ent-occitanie.fr/mobilite |
36+
| Arsène 76 | PROD_ARSENE76 | https://mobilite.arsene76.fr/mobilite |
37+
| ENT27 | PROD_ENT27 | https://mobilite.ent27.fr/mobilite |
38+
| ENT Creuse | PROD_ENTCREUSE | https://mobilite.entcreuse.fr/mobilite |
39+
| ENT Auvergne-Rhône-Alpes | PROD_AUVERGNERHONEALPES | https://mobilite.ent.auvergnerhonealpes.fr/mobilite |
40+
| Agora 06 | PROD_AGORA06 | https://mobilite.agora06.fr/mobilite |
41+
| CyberCollèges 42 | PROD_CYBERCOLLEGES42 | https://mobilite.cybercolleges42.fr/mobilite |
42+
| eCollège 31 Haute-Garonne | PROD_ECOLLEGE_HAUTE_GARONNE | https://mobilite.ecollege.haute-garonne.fr/mobilite |
43+
| Mon collège en Val d'Oise | PROD_MONCOLLEGE_VALDOISE | https://mobilite.moncollege.valdoise.fr/mobilite |
44+
| Webcollège Seine-Saint-Denis | PROD_WEBCOLLEGE_SEINESAINTDENIS | https://mobilite.webcollege.seinesaintdenis.fr/mobilite |
45+
| Eclat-BFC | PROD_ECLAT_BFC | https://mobilite.eclat-bfc.fr/mobilite |
46+
| @ucollège84 | PROD_AUCOLLEGE84_VAUCLUSE | https://mobilite.aucollege84.vaucluse.fr/mobilite |
47+
| ENT Val de Marne | PROD_ENT_VAL_DE_MARNE | https://mobilite.entvaldemarne.skolengo.com/mobilite |
48+
| Skolengo | PROD_SKOLENGO | https://mobilite.skolengo.com/mobilite |
49+
| Kosmos Éducation | PROD_KOSMOS_EDUCATION | https://mobilite.kosmoseducation.com/mobilite |
50+
| Skolengo-Collèges et Lycées | PROD_KOSMOS_EDUCATION_PDL | https://mobilite.pdl.kosmoseducation.com/mobilite |
51+
| Schulportal Ostbelgien | PROD_SCHULPORTAL_OSTBELGIEN | https://mobilite.schulen.be/mobilite |
52+
53+
Une autre méthode pour obtenir un token est d'utiliser la ligne de commande:
54+
```shell
55+
npx kdecole-api -u USERNAME -p CODE --ent PROD_MON_BUREAU_NUMERIQUE
56+
```
57+
58+
{{>main}}

‎package.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "kdecole-api",
3-
"version": "1.4.3",
4-
"main": "dist/Kdecole.js",
5-
"types": "types/Kdecole.d.ts",
3+
"version": "1.4.4",
4+
"main": "dist/index.js",
5+
"types": "types/index.d.ts",
66
"bin": {
77
"kdecole": "bin/kdecole-api"
88
},
@@ -32,7 +32,7 @@
3232
"build": "npx tsc -p tsconfig.json",
3333
"lint": "npx eslint src/ --ext .ts",
3434
"test": "npx jest",
35-
"doc": "npx jsdoc2md -f dist/Kdecole.js > README.md"
35+
"doc": "npx jsdoc2md --template docs/README.hbs -f dist/index.js > README.md"
3636
},
3737
"repository": {
3838
"type": "git",

0 commit comments

Comments
 (0)