Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aschuma/dsb-untis
A RESTful Docker-based service for fetching and converting HTML-based Untis Timetables from DSB into a more accessible JSON format.
https://github.com/aschuma/dsb-untis
docker docker-image dsb javascript library nodejs rest rest-server server untis untis-timetable
Last synced: 28 days ago
JSON representation
A RESTful Docker-based service for fetching and converting HTML-based Untis Timetables from DSB into a more accessible JSON format.
- Host: GitHub
- URL: https://github.com/aschuma/dsb-untis
- Owner: aschuma
- License: mit
- Created: 2021-01-17T15:16:56.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-25T14:08:37.000Z (2 months ago)
- Last Synced: 2024-09-27T01:52:22.306Z (about 1 month ago)
- Topics: docker, docker-image, dsb, javascript, library, nodejs, rest, rest-server, server, untis, untis-timetable
- Language: JavaScript
- Homepage:
- Size: 147 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](http://npm.im/dsb-untis)
[](http://npm-stat.com/charts.html?package=dsb-untis&from=2021-01-01)
[](http://opensource.org/licenses/MIT)
# DSB crawler and Untis's HTML parser / REST service
## Basic Usage
```javascript
import DsbUntis from 'dsb-untis';
const username = "165931";
const password = "secret";
const dsbUntis = new DsbUntis(username, password);
dsbUntis.fetch().then((data) => {
console.log(JSON.stringify(data))
});
```
## Server Mode
Start an HTTP server on port 8080 to serve the data using the subsequent javascript code. You can use `curl` or your web browser to retrieve the data by accessing `http://localhost:8080`:
```javascript
import DsbUntis = from 'dsb-untis';
const username = "165931";
const password = "secret";
const dsbUntis = new DsbUntis(username, password);
dsbUntis.listen(8080);
```
## Server Mode / Docker Image
Supported platforms:
* linux/amd64
* linux/arm64
* linux/arm/v7 (PI 4B)
Start an HTTP server on port 8080 to serve the data using the subsequent shell command. You can use `curl` or your web browser to retrieve the data by accessing `http://localhost:8080`.
```shell
docker run --rm -d -e USERNAME="165931" -e PASSWORD="secret" -p 8080:8080 aschuma/dsb-untis:latest
```
## Example Result
```json
[
{
"date": "2021-01-15T16:33:00.000Z",
"dateString": "15.01.2021 17:33",
"table": [
[
"Datum",
"Tag",
"Fach",
"Stunde",
"Lehrer",
"Text",
"Raum",
"(Fach)",
"Art",
"Vertr. von / verlegt"
],
[
"6b"
],
[
"15.1.",
"Fr",
"E",
"3 - 4",
"Kmt",
"",
"---",
"E",
"Entfall",
""
],
[
"9c"
],
[
"15.1.",
"Fr",
"D",
"6",
"Nlr",
"",
"R109",
"D",
"Vertretung",
""
]
]
},
{
"date": "2021-01-15T16:33:00.000Z",
"dateString": "15.01.2021 17:33",
"table": [
[
"Datum",
"Tag",
"Klasse(n)",
"Fach",
"Stunde",
"Lehrer",
"Text",
"Raum",
"(Fach)",
"Grund: (Lehrer)",
"Art",
"Vertr. von / verlegt"
],
[
"6b"
],
[
"18.1.",
"Mo",
"6b",
"Mu",
"3 - 4",
"Bo",
"",
"MuS",
"Mu",
"Kfm",
"Vertretung",
""
],
[
"7a"
],
[
"18.1.",
"Mo",
"7a",
"D",
"1 - 2",
"Cla",
"",
"R008",
"D",
"Kfm",
"Vertretung",
""
],
[
"9a"
],
[
"18.1.",
"Mo",
"9a, 9b, 9c",
"EvR",
"3 - 4",
"Btl",
"",
"---",
"EvR",
"Btl",
"Entfall",
""
],
[
"9b"
],
[
"18.1.",
"Mo",
"9a, 9b, 9c",
"EvR",
"3 - 4",
"Bl",
"",
"---",
"EvR",
"Btl",
"Entfall",
""
],
[
"9c"
],
[
"18.1.",
"Mo",
"9a, 9b, 9c",
"EvR",
"3 - 4",
"Btl",
"",
"---",
"EvR",
"Btl",
"Entfall",
""
],
[
"10a"
],
[
"18.1.",
"Mo",
"10a, 10b, 10c",
"EvR",
"1 - 2",
"Btz",
"",
"---",
"EvR",
"Btl",
"Entfall",
""
],
[
"18.1.",
"Mo",
"10a",
"Mu",
"5",
"Trä",
"",
"MuS",
"Mu",
"Kfn",
"Vertretung",
""
],
[
"10b"
],
[
"18.1.",
"Mo",
"10a, 10b, 10c",
"EvR",
"1 - 2",
"Btl",
"",
"---",
"EvR",
"Btl",
"Entfall",
""
]
]
},
{
"date": "2021-01-15T16:33:00.000Z",
"dateString": "15.01.2021 17:33",
"table": [
[
"Datum",
"Tag",
"Klasse(n)",
"Fach",
"Stunde",
"Lehrer",
"Text",
"Raum",
"(Fach)",
"Grund: (Lehrer)",
"Art",
"Vertr. von / verlegt"
],
[
"10c"
],
[
"18.1.",
"Mo",
"10a, 10b, 10c",
"EvR",
"1 - 2",
"Btl",
"",
"---",
"EvR",
"Btz",
"Entfall",
""
],
[
"Jg2"
],
[
"18.1.",
"Mo",
"Jg2",
"er",
"8 - 9",
"Btl",
"",
"---",
"er",
"Btl",
"Entfall",
""
]
]
}
]
```
## Advanced Feature
The returned data can be customized by passing a list of ```extractors``` to the ```fetch``` method.
There are some built-in extractors located in the
```src/timetableHtmlExtractors``` folder, however, you can also create your own custom extractors if needed.