friendly-public-transport-format

A format for APIs, libraries and datasets containing and working with public transport data.

Showing:

Popularity

Downloads/wk

12

GitHub Stars

74

Maintenance

Last Commit

1mo ago

Contributors

5

Package

Dependencies

0

License

CC-BY-SA-4.0

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Friendly Public Transport Format (FPTF)

This repo outlines a format for APIs, libraries and datasets containing and working with public transport data. See the spec and the list of JS modules.

npm version CC-licensed chat on gitter

It tries to keep things simple:

  • JSON and ndjson only
  • a flat, intuitive representation of public transport timetables & infrastructure
  • conceptually inspired by the de-facto standard GTFS

Specifically, it trades

  • efficiency for consumability: GTFS sets feel like database dumps.
  • completeness for ease-of-use: Only basic attributes are required, most is optional.

Things still missing:

  • concise definitions
  • clear naming & recommendations for optional data

There's also a work-in-progress spec for APIs building on top of the FPTF format: the Friendly Public Transport Interface for JavaScript (FPTI-JS).

Contributing

We are looking forward to discuss & extend this format further! If you have a question or want to propose changes, go to the issues page. Keep our contributing guidelines in mind. Note that, by participating in this project, you commit to the code of conduct.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100