Package Exports

netschoolapi
netschoolapi/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (netschoolapi) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

NetSchoolApi

Это враппер для продукта "Сетевой город. Образование". С помощью которого вы можете получить информацию о пользователе (дневник, расписание и т.д.)

Начало работы

Эти инструкции позволят вам запустить копию проекта на вашем локальном компьютере для целей разработки и тестирования.

Предварительные условия

Чтобы установить библиотеку, вам необходимо:

NodeJS ≥ v10.24.1 (установить)

Установка

Для установки необходимо ввести команду

npm i netschoolapi

Проверка установки

В корне проекта создайте файл test.js
В этот файл вставьте код ниже (введя ваши данные)

const NS = require("netschoolapi").default;
const user = new NS({
  origin: "https://example.com/", // Origin вашего сайта
  login: "Иванов", // Ваш логин
  password: "******", // Ваш пароль
  school: "МБОУ ....", // Название вашей школы (как на сайте)
});

(async function () {
  const info = await user.info();
  console.log(info);
})();

Запустите этот код введя в консоли команду

node test.js

Если в консоли не выводится информация о пользователе, то проверьте версию NodeJS или создайте issue

Информация о библиотеке

Сделано с помощью

ws - Клиентская реализация WebSocket
node-fetch - Fetch API в Node.js
node-html-parser - Генерация упрощенного DOM-дерева с поддержкой запросов к элементам.

Управление версиями

Мы используем SemVer для управления версиями. Доступные версии см. в разделе теги.

Авторы

lentryd

Смотрите также список участников, которые участвовали в этом проекте.

Лицензия

Этот проект лицензирован по лицензии MIT - см. LICENSE файл для получения подробной информации