# vulcan-scraper

> Small library to scrape Vulcan e-register

Latest version **1.5.0** (published 2024-01-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install vulcan-scraper
pnpm add vulcan-scraper
yarn add vulcan-scraper
bun add vulcan-scraper
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2024-01-09 |
| First published | 2023-10-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 52.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | kabus |
| Maintainers | kabuspl |
| Keywords | uonet, uonetplus, vulcan, scraper |

## Links

- npm: https://www.npmjs.com/package/vulcan-scraper
- Repository: https://github.com/kabuspl/vulcan-scraper
- Homepage: https://github.com/kabuspl/vulcan-scraper#readme
- Issues: https://github.com/kabuspl/vulcan-scraper/issues
- npm.io page: https://npm.io/package/vulcan-scraper

## Dependencies (3)

- [url](https://npm.io/package/url.md) ^0.11.3
- [fetch-cookie](https://npm.io/package/fetch-cookie.md) ^2.1.0
- [node-html-parser](https://npm.io/package/node-html-parser.md) ^6.1.10

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 1.5.0 (latest) — 2024-01-09
- 1.4.0 — 2024-01-03
- 1.3.0 — 2023-11-18
- 1.2.0 — 2023-11-07
- 1.1.0 — 2023-10-02
- 1.0.0 — 2023-10-02

## README

# vulcan-scraper
![npm](https://img.shields.io/npm/v/vulcan-scraper)
![npm](https://img.shields.io/npm/dw/vulcan-scraper)

Small library to scrape Vulcan e-register

## Documentation/Usage
Basic documentation is available in this repo's [wiki](https://github.com/kabuspl/vulcan-scraper/wiki).

## Example
```js
import { VulcanHandler } from "vulcan-scraper";

const vulcanHandler = new VulcanHandler("student@school.com", "P@ssw0rd", "city");

await vulcanHandler.login();

console.log(await vulcanHandler.getStudentGrades());

await vulcanHandler.logout();
```
Output:
```js
{
  'Język polski': { average: 2, grades: [ [Object] ] },
  'Język angielski': { average: 0, grades: [] },
  'Tworzenie stron i aplikacji internetowych': { average: 5.5, grades: [ [Object] ] },
  'Systemy baz danych': { average: 0, grades: [] },
  'Projektowanie baz danych': { average: 4.5, grades: [ [Object], [Object] ] }
}
```

## Limitations
- Currently this library only supports standard login type

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