Skip to content

KathleenQ/gtfs-validator

 
 

Repository files navigation

gtfs-validator Test Package Document CircleCI End to end Join the gtfs-validator chat

A GTFS Schedule (static) General Transit Feed Specification (GTFS) feed validator

Introduction

This command-line tool written in Java that performs the following steps:

  1. Loads input GTFS zip file from a URL or disk
  2. Checks file integrity, numeric type parsing and ranges as well as string format according to the GTFS Schedule specification
  3. Performs GTFS business rule validation (work-in-progress)

Build the code

We suggest using IntelliJ to import, build, and run this project.

Instructions to build the project from the command-line using Gradle are available in our Build documentation.

Run the app

If you're running a v1.x release JAR file you'll need Java 11, and can follow these instructions. The below instructions are for the master branch, which will be v2.0.

(Instructions to run a pre-built JAR file are coming soon)

From IntelliJ set up a run configuration with the following program arguments:

-i /myDirectory/gtfs.zip -o output -f ca-myFeedName

where:

  • --input or -i: the path to the GTFS archive (e.g., /myDirectory/gtfs.zip)
  • --output or -o: the path to the validation report (e.g., output)
  • --feed_name or -f: the name of the feed as a valid ISO two letter country code, followed by -, followed by a user-defined name for the feed. (e.g., ca-myFeedName, us-myFeedName)
  • (Optional) --thread or -t: the number of Java threads to use

More detailed instructions to run the application locally are available in our Usage page.

Architecture

The architecture of the gtfs-validator is described on our Architecture page.

License

Code licensed under the Apache 2.0 License.

Contributing

We welcome contributions to the project! Please check out our Contribution guidelines for details.

About

Canonical GTFS Validator project for schedule (static) files from a zip archive

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Java 99.9%
  • Dockerfile 0.1%