Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/derhuerst/sbahn-berlin-tweets
Fetch & parse @SBahnBerlin tweets on the operating status of S-Bahn Berlin.
https://github.com/derhuerst/sbahn-berlin-tweets
berlin public-transport sbahn transit
Last synced: 5 days ago
JSON representation
Fetch & parse @SBahnBerlin tweets on the operating status of S-Bahn Berlin.
- Host: GitHub
- URL: https://github.com/derhuerst/sbahn-berlin-tweets
- Owner: derhuerst
- License: isc
- Created: 2019-09-04T23:24:04.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2019-10-29T19:27:49.000Z (about 5 years ago)
- Last Synced: 2024-10-03T23:56:19.071Z (about 1 month ago)
- Topics: berlin, public-transport, sbahn, transit
- Language: JavaScript
- Homepage: https://github.com/derhuerst/parse-sbahn-berlin-tweets#parse-sbahn-berlin-tweets
- Size: 31.3 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# sbahn-berlin-tweets
**Fetch & parse [`@SBahnBerlin`](https://mobile.twitter.com/SBahnBerlin) tweets on the operating status of [S-Bahn Berlin](https://en.wikipedia.org/wiki/Berlin_S-Bahn).** Caveats:
- It guesses lines and stations just by their name. This is brittle.
- It relies on specific phrases & keywords commonly used by the `SBahnBerlin` twitter account.
[](https://www.npmjs.com/package/sbahn-berlin-tweets)
[](https://travis-ci.org/derhuerst/sbahn-berlin-tweets)
[](https://gitter.im/derhuerst)
[](https://patreon.com/derhuerst)
## Installation
```shell
npm install sbahn-berlin-tweets
```
## Usage
### fetching & parsing tweets
```js
const fetchAndParseTweets = require('sbahn-berlin-tweets')
const [tweet] = await fetchAndParseTweets(1, {
formatLine: l => l.id,
formatStation: s => s.id
})
console.log(tweet)
```
```js
{
id: '1169225032700239872',
cause: 'medical-emergency',
effect: 'disruptions',
affected: ['S3', 'S5', 'S7', 'S9'],
runsOnlyBetween: null,
stations: ['900000024204'], // Savignyplatz
useLines: []
}
```
### parsing tweets
```js
const parse = require('sbahn-berlin-tweets/parse')
console.log(parse({
id: '1169246704291524608',
text: [
{type: 'hashtag', content: 'S7'},
{type: 'plain', content: ': Wegen einer Weichenstörung in '},
{type: 'hashtag', content: 'Olympiastadion'},
{type: 'plain', content: ' verkehrt die S7 nur zwischen '},
{type: 'hashtag', content: 'Ahrensfelde'},
{type: 'plain', content: ' <> '},
{type: 'hashtag', content: 'Westkreuz'},
{type: 'plain', content: '. Der 10-Minutentakt kann nur zwischen Ahrensfelde <> '},
{type: 'hashtag', content: 'Charlottenburg'},
{type: 'plain', content: ' angeboten werden. Von/nach Olympiastadion/Spandau nutzen Sie bitte die Züge der '},
{type: 'hashtag', content: 'S3'},
{type: 'plain', content: ' und '},
{type: 'hashtag', content: 'S9'},
{type: 'plain', content: '.'}
]
}))
```
```js
{
cause: 'switch-failure',
effect: 'skipped-stops',
affected: [
// from the `vbb-lines` npm package
{id: '10162_109', name: 'S7'}
],
stations: [
// from the `vbb-stations` npm package
{id: '900000025321', name: 'S Olympiastadion'}
],
useLines: [
// from the `vbb-lines` npm package
{id: '10148_109', name: 'S3'},
{id: '10170_109', name: 'S9'}
],
runsOnlyBetween: null
}
```
## Related
- [`augment-vbb-hafas`](https://github.com/derhuerst/augment-vbb-hafas) – Augment [VBB HAFAS](https://npmjs.com/package/vbb-hafas) responses with realtime data from other channels.
- [`vbb-disruptions`](https://github.com/derhuerst/vbb-disruptions) – Disruptions in VBB public transport.
## Contributing
If you have a question or need support using `sbahn-berlin-tweets`, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to [the issues page](https://github.com/derhuerst/sbahn-berlin-tweets/issues).