Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/public-transport/gtfs-to-fptf
Convert GFTS data to FPTF: lib & CLI.
https://github.com/public-transport/gtfs-to-fptf
converter fptf friendly-public-transport-format gtfs public-transport public-transportation transit
Last synced: 3 months ago
JSON representation
Convert GFTS data to FPTF: lib & CLI.
- Host: GitHub
- URL: https://github.com/public-transport/gtfs-to-fptf
- Owner: public-transport
- License: isc
- Created: 2017-10-26T05:24:16.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-06-08T08:36:24.000Z (over 2 years ago)
- Last Synced: 2024-04-14T07:11:20.157Z (10 months ago)
- Topics: converter, fptf, friendly-public-transport-format, gtfs, public-transport, public-transportation, transit
- Language: JavaScript
- Size: 94.7 KB
- Stars: 4
- Watchers: 5
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# gtfs-to-fptf
Convert [GTFS](https://developers.google.com/transit/gtfs/) data to [FPTF](https://github.com/public-transport/friendly-public-transport-format): library and CLI.
*Work in progress. This software is not stable yet. See the [to-do](#to-do) section.*
[](https://www.npmjs.com/package/gtfs-to-fptf)
[](https://david-dm.org/public-transport/gtfs-to-fptf)
[](https://david-dm.org/public-transport/gtfs-to-fptf#info=devDependencies)
[](LICENSE)
[](https://gitter.im/juliuste)
## Installation
### CLI
```shell
npm install -g gtfs-to-fptf
```
### Library
```shell
npm install --save gtfs-to-fptf
```
## Usage
### CLI
```shell
gtfs-to-fptf gtfs-directory fptf-directory
```
### Library
```js
toFPTF(gtfsDirectory, workingDirectory = null)
```
`gtfsDirectory` is the path to a directory containing `.txt` files, via the optional `workingDirectory` you can change where the scripts creates a temporary `level` db.
Returns a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/promise) that will resolve in an object containing FPTF object streams.
Currently, the following GTFS files are supported:
- `agency.txt` **required**
- `stops.txt` **required**
- `routes.txt` **required**
- `trips.txt` **required**
- `stop_times.txt` **required**
- `calendar.txt` *optional*, **required** if `calendar_dates.txt` is not provided
- `calendar_dates.txt` *optional*, **required** if `calendar.txt` is not provided
- `shapes.txt` **optional**
```js
const toFPTF = require('gtfs-to-fptf')
toFPTF('./bus-gtfs/')
.then((fptf) => {
fptf.stations.pipe(someStream)
fptf.schedules.pipe(someOtherStream)
})
```
The FPTF object contains the following streams:
- `operators`
- `stops`
- `stations`
- `lines`
- `routes`
- `schedules`
## To do
- extended testing (there's probably still a lot of bugs)
- improve error handling
- dependency cleanup
- tests
## Contributing
If you found a bug, want to propose a feature or feel the urge to complain about your life, feel free to visit [the issues page](https://github.com/public-transport/gtfs-to-fptf/issues).