README.md

GTFS.Net

General Transit Feed Specification (GTFS) data parser

How to Install

Install via NuGet.

  Install-Package GtfsNet

Example

1. Create a parser
2. parse specified folder location ("feeds/subway" in the example below)
3. Optional step: Validate the feed according to GTFS specification.

  GtfsFeedParser parser = new GtfsFeedParser();
  GtfsFeed feed = parser.Parse("feeds/subway");
  // Optional step
  GtfsFeedValidator validator = new GtfsFeedValidator();
  validator.Validate(feed);

Implementation detail

• Both Parser and Validator are implemented using a Visitor Design Pattern.
• GtfsFeedParser is created as a facade for GtfsFeedParserVisitor because calling GtfsFeedParserVisitor instance directly makes the caller's code harder to read.
• GtfsFeedValidator is also a facade for two different validators.
  1. RequiredFileVisitor: Check if all required files are parsed in a feed.
  2. RequiredFieldVisitor: Check if all required fields in each file are parsed in a feed

Credit

Many entity classes are copied from OsmSharp/GTFS project.

Next Version

• Implement async methods