Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Mati365/librus-api
Advanced node.js Librus scraping API(http://synergia.librus.pl/)
https://github.com/Mati365/librus-api
dziennik librus librus-api librus-synergia scrapping szkola
Last synced: about 2 months ago
JSON representation
Advanced node.js Librus scraping API(http://synergia.librus.pl/)
- Host: GitHub
- URL: https://github.com/Mati365/librus-api
- Owner: Mati365
- Created: 2015-12-10T08:31:08.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-06T09:50:39.000Z (5 months ago)
- Last Synced: 2024-02-07T06:42:22.635Z (5 months ago)
- Topics: dziennik, librus, librus-api, librus-synergia, scrapping, szkola
- Language: JavaScript
- Homepage: http://synergia.librus.pl/
- Size: 113 KB
- Stars: 99
- Watchers: 15
- Forks: 23
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Lists
- awesome-school-projects-poland - Mati365/librus-api
README
# librus-api
[](https://www.npmjs.com/package/librus-api)
[](http://opensource.org/licenses/MIT)
Otwartoźródłowy klient HTTP parsujący odpowiedzi HTML serwera dziennika elektronicznego Librus / Synergia. Paczka nie jest oficjalnym produktem Synergia.
## Instalacja
```
npm install librus-api
```
## Usage
```javascript
"use strict";
const Librus = require("librus-api");
let client = new Librus();
client.authorize("login", "pass").then(function () {
// Send message to User 648158
client.inbox.sendMessage(648158, "title", "body").then(
() => {
/** sucess */
},
() => {
/** fail **/
}
);
// Remove message with id 4534535
client.inbox.removeMessage(4534535).then(
() => {
/** sucess */
},
() => {
/** fail **/
}
);
// List receivers
client.inbox.listReceivers("nauczyciel").then((data) => {});
// List announcements
client.inbox.listAnnouncements().then((data) => {});
// List all e-mails in folder(5) in page(2)
client.inbox.listInbox(5).then((data) => {});
// Get message with id 2133726 in folder 6
client.inbox.getMessage(6, 2133726).then((data) => {});
// Get attachments from message with id 181186 in folder 5
client.inbox.getMessage(5, 181186).then((data) => {
for (let f of data.files) {
client.inbox
.getFile(f.path)
.then((response) => response.pipe(fs.createWriteStream(f.name)));
}
});
// List all subjects
client.homework.listSubjects().then((data) => {});
// List subject homeworks, -1||undefined all
client.homework.listHomework(24374).then((list) => {});
// Download homework description
client.homework.getHomework(257478).then((data) => {});
// Get all absences
client.absence.getAbsences().then((data) => {});
// Get info about absence
client.absence.getAbsence(5068489).then((data) => {});
// Get timetable
client.calendar.getTimetable().then((data) => {});
// Get calendar
client.calendar.getCalendar().then((data) => {});
// Get event
client.calendar.getEvent(4242342).then((data) => {});
// Get grades
client.info.getGrades().then((data) => {});
// Get grade
client.info.getGrade(23424234).then((data) => {});
// Get scoring grade
client.info.getPointGrade(234242234).then((data) => {});
// Get name, surname and other account info
client.info.getAccountInfo();
// Get lucky number
client.info.getLuckyNumber().then((data) => {});
// Get notifications
client.info.getNotifications().then((data) => {});
});
```
## Licencja
The MIT License (MIT)
Copyright (c) 2023/2024 Mateusz Bagiński
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.