NetSchoolApi - Враппер для продукта "Сетевой город. Образование"

NetSchoolApi - это враппер для продукта "Сетевой город. Образование", предоставляющий доступ к информации о пользователе, такой как дневник, расписание и другие данные.

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

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

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

Перед установкой и использованием этой библиотеки убедитесь, что у вас установлены следующие компоненты:

Node.js версии 10.24.1 или выше

Установка

Вы можете установить библиотеку с помощью следующей команды:

npm i netschoolapi

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

Создайте файл test.js в корне проекта.
Вставьте следующий код в файл 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 на GitHub.

Дополнительная информация о библиотеке

Зависимости

Для работы этой библиотеки используются следующие зависимости:

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

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

Версии этой библиотеки управляются согласно SemVer. Список доступных версий можно найти в разделе теги.

Авторы

lentryd

Также посмотрите список участников, которые внесли свой вклад в проект.

Лицензия

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

Помощь/Общение

Для получения помощи и общения присоединяйтесь к Telegram-чату

lentryd/NetSchoolApi