# node-webtop

> A node library for Webtop.co.il (scraped using mobile version)

Latest version **1.0.1** (published 2016-12-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-webtop
pnpm add node-webtop
yarn add node-webtop
bun add node-webtop
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2016-12-10 |
| First published | 2016-12-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jonathan Ohayon |
| Maintainers | rezozo |
| Keywords | webtop, smartschool |

## Links

- npm: https://www.npmjs.com/package/node-webtop
- Repository: https://github.com/rezozo/node-webtop
- Homepage: https://github.com/rezozo/node-webtop#readme
- Issues: https://github.com/rezozo/node-webtop/issues
- npm.io page: https://npm.io/package/node-webtop

## Dependencies (5)

- [moment](https://npm.io/package/moment.md) ^2.17.1
- [cheerio](https://npm.io/package/cheerio.md) ^0.22.0
- [truncate](https://npm.io/package/truncate.md) ^2.0.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^1.6.3
- [whatwg-fetch](https://npm.io/package/whatwg-fetch.md) ^2.0.1

## Recent versions

- 1.0.1 (latest) — 2016-12-10
- 1.0.0 — 2016-12-10

## README

node-webtop
===

##What is this?
This small library allows you to access data from webtop.co.il, a popular system which schools in Israel are using in order to notify students about important messages, time changes, events happening at school and their grades.

##Why have you built this?
The service is designed like it's 2003, so I wanted to build a redesign of it. In order to do that, I needed acess to their data (aka each student's time table, time changes, messages...).

It's worth noting that the library is supported both in node and in the browser.

##Typical workflow
```js
const { Student } = require('node-webtop')

const s = new Student({
  username: 'example',
  password: 'example1'
})

s.login().then(() => {
  return s.getMessages()
}).then(messages => {
  console.log(messages)
}).catch(err => console.error(err))
```

##Available methods
`Student#login, Student#logout, Student#getTimetable, Student#getTimeChanges, Student#getEvents, Student#getMessages, Student#getInbox, Student#searchInbox, Student#getMessage`

##Feature list
 - [x] Login and logout
 - [x] Timetable
 - [x] Timetable changes and events
 - [x] Get messages from inbox
 - [x] Get message by ID
 - [ ] Search inbox
 - [ ] Get grades
 - [ ] Send messages

---
_Source: https://npm.io/package/node-webtop · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._