isenjs
Version:
A Nodejs API wrapper for ISEN-OUEST, with webAurion information like calendar, grades, absences...
292 lines (201 loc) • 8.07 kB
Markdown
<br>
<p align="center"><img width="400" alt="Logo" src="https://raw.githubusercontent.com/CorentinMre/isenjs/main/images/icon.jpg"></a></p>
<br/>
<h2 style="font-family: sans-serif; font-weight: normal;" align="center"><strong>An API for ISEN-OUEST</strong></h2>
<br/>
<h2 style="font-family: sans-serif; font-weight: normal;" align="center"><strong>⚠️ Unofficial !!</strong></h2>
[](https://www.npmjs.org/package/isenjs)
[](https://www.npmjs.org/package/isenjs)
## Description
A Nodejs API wrapper for ISEN-OUEST, with webAurion information like calendar, grades, absences...
## Usage
- `npm install isenjs`
## Here is an example script with login:
```js
const { Client } = require('isenjs');
// Create the client
const client = new Client("<username>",
"<password>"
);
(async () => {
try {
const logged_in = await client.logged_in; // don't forget to put this line to log in the user
if (!logged_in) {
console.error("Login failed");
return;
}
// Get User Info
const userInfo = await client.userInfo();
console.log("User Info:", userInfo);
} catch (error) {
console.error("Error:", error);
}
})();
```
## Here is an example script to get absences from webAurion:
```js
const { WebAurion } = require('isenjs'); // don't forget to import WebAurion
const client = new WebAurion("<username>",
"<password>");
(async () => {
try {
const logged_in = await client.logged_in; // don't this line for login the user
if (!logged_in) {
console.error("Login failed");
return;
}
const absences = await client.absences();
console.log(absences);
// console.log(absences.toJSON()); // to have the Object
} catch (error) {
console.error("Error:", error);
}
})();
```
## Here is an example script to get grades from webAurion:
```js
const { WebAurion } = require('isenjs'); // don't forget to import WebAurion
const client = new WebAurion("<username>",
"<password>");
(async () => {
try {
const logged_in = await client.logged_in; // don't this line for login the user
if (!logged_in) {
console.error("Login failed");
return;
}
const grades = await client.grades();
console.log(grades);
// console.log(grades.toJSEON()); // to have the Object
} catch (error) {
console.error("Error:", error);
}
})();
```
## Here is an example to get planning from webAurion
```js
const { WebAurion } = require('isenjs'); // don't forget to import WebAurion
const client = new WebAurion("<username>",
"<password>");
(async () => {
try {
const logged_in = await client.logged_in; // don't this line for login the user
if (!logged_in) {
console.error("Login failed");
return;
}
// params: start_date : (str, optional) , end_date : (str, optional)
// format (Ex. "12-08-2023")
// default : the current week
const planning = await client.planning();
console.log(planning);
//console.log(planning.toJSON()); // to have the Object
} catch (error) {
console.error("Error:", error);
}
})();
```
## Here is an other example if you want group schedule
```js
const { WebAurion } = require('isenjs'); // don't forget to import WebAurion
const client = new WebAurion("<username>",
"<password>");
(async () => {
try {
const logged_in = await client.logged_in; // don't this line for login the user
if (!logged_in) {
console.error("Login failed");
return;
}
// params: cycle : str , year : str, city: str, start_date : (str, optional) , end_date : (str, optional)
// format (Ex. "12-08-2023")
// default : the current week
const groupPlanning = await client.groupPlanning("CIR", "2", "Caen", "16-08-2023", "16-05-2024");
console.log(planning);
//console.log(groupPlanning.toJSON()); // to have the Object
} catch (error) {
console.error("Error:", error);
}
})();
```
## Here is an other example if you want room schedule
```js
const { WebAurion } = require('isenjs'); // don't forget to import WebAurion
const client = new WebAurion("<username>",
"<password>");
(async () => {
try {
const logged_in = await client.logged_in; // don't this line for login the user
if (!logged_in) {
console.error("Login failed");
return;
}
// params: city: str, start_date : (str, optional) , end_date : (str, optional)
// format (Ex. "12-08-2023")
// default : the current week
const roomPlanning = await client.roomPlanning("Caen", "16-08-2023", "16-05-2024");
console.log(roomPlanning);
//console.log(roomPlanning.toJSON()); // to have the Object
} catch (error) {
console.error("Error:", error);
}
})();
```
## Example for get your school report
```js
const { WebAurion } = require('isenjs'); // don't forget to import WebAurion
const client = new WebAurion("<username>",
"<password>");
(async () => {
try {
const logged_in = await client.logged_in; // don't this line for login the user
if (!logged_in) {
console.error("Login failed");
return;
}
const schoolReport = await client.getSchoolReport();
console.log(schoolReport);
//console.log(schoolReport.toJSON()); // to have the Object
} catch (error) {
console.error("Error:", error);
}
})();
```
## Example for download your school report
```js
const { WebAurion } = require('isenjs'); // don't forget to import WebAurion
const client = new WebAurion("<username>",
"<password>");
(async () => {
try {
const logged_in = await client.logged_in; // don't this line for login the user
if (!logged_in) {
console.error("Login failed");
return;
}
await client.downloadReport() // Download all your school report with the default name
// if you want only one report
// client.downloadReport(null, "report_id")
// Download the report with the id "report_id" with the default name (you have the id with the schoolReport object Ex. schoolReport = webAurion.getSchoolReport() )
} catch (error) {
console.error("Error:", error);
}
})();
```
## LICENSE
Copyright (c) 2023 CorentinMre
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.