Skip to content

Latest commit

 

History

History
87 lines (64 loc) · 6.26 KB

USAGE.md

File metadata and controls

87 lines (64 loc) · 6.26 KB
Raw

Instructions to run the application locally

The below instructions are for the v3.0.0-beta release.

  1. Install Java 11 or higher.
  2. Download the latest gtfs-validator JAR file from our Releases page.

via cli-app

Full list of command line parameters available

Short name Long name required? Description
-i --input Optional Location of the input GTFS ZIP or unarchived directory.
-c --country_code Optional Country code of the feed, e.g., nl. It must be a two-letter country code (ISO 3166-1 alpha-2).
-h --help Optional Print help menu.
-o --output Optional Base directory to store the outputs.
-s --storage_directory Optional Target path where to store the GTFS archive. Downloaded from network (if not provided, the ZIP will be stored in memory).
-t --threads Optional Number of threads to use.
-u --url Optional Fully qualified URL to download GTFS archive.
-v --validation_report_name Optional Name of the validation report (including .json extension).
-e --system_errors_report_name Optional Name of the system errors report (including .json extension).
-n --export_notices_schema Optional Export notice schema as a json file.

⚠️ Note that exactly one of the following options must be provided: --url or --input.

⚠️ Note that --storage_directory must not be provided if --url is not provided.

⚠️ Note that parameters marked with an asterisk (*) in the help menu are mandatory.

on a local GTFS zip file

Sample usage:

java -jar gtfs-validator-v3.0.0-beta.jar --input relative/path/to/dataset.zip --output relative/output/path --country_code <country_code> --threads <number_of_threads_to_use>

...which will:

  1. Search for a GTFS dataset located at relative/path/to/dataset.zip
  2. Validate the GTFS data and output the results to the directory located at relative/output/path.
  3. Export both validation and system errors reports to JSON by default. This folder will contain the .json file with information related to the validation process. The validation report will (by default) be named as report.json and the system errors report can be found under the name of system_errors.json.

⚠️ Note that reports naming can be overridden by providing values to -validation_report_name and/or -system_errors_report_name CLI arguments. These should include .json extension.

on a hosted GTFS zip file at a URL

Sample usage:

java -jar gtfs-validator-v3.0.0-beta.jar --url https://url/to/dataset.zip --output relative/output/path --country_code <country_code> --threads <number_of_threads_to_use> --storage_directory input.zip

...which will:

  1. Download the GTFS feed at the URL https://url/to/dataset.zip and name it input.zip
  2. Validate the GTFS data and output the results to the directory located at relative/output/path. Validation results are exported to JSON by default. Please note that since downloading will take time, we recommend validating repeatedly on a local file.

via GitHub Actions - Run the validator on any gtfs archive available on a public url

  1. Fork this repository
  2. Open a PR on master within it
  3. Edit the file .github/workflows/end_to_end.yml following instructions on lines 5, 43-45 and push on your PR branch (see detailed instructions here)
  4. Name your branch from the agency/authority/publisher of the feed you are testing

You should now see the workflow End to end / run-on-data start automatically in your PR checks, running the validator on the dataset you just added. The validation report is collected as a run artifact in the Actions tab of your fork repository on GitHub.

If the workflow run crashes or something doesn't look right in the validation report json file, please see the guide to reproduce section.

Export notice schema

Sample usage:

Without file validation

java -jar gtfs-validator-v3.0.0-beta.jar --export_notice_schema

...which will:

  1. Generate and export all validation notices as a json file.

With file validation

java -jar gtfs-validator-v3.0.0-beta.jar --export_notice_schema --url https://url/to/dataset.zip --output relative/output/path --country_code <country_code> --threads <number_of_threads_to_use> --storage_directory input.zip

...which will:

  1. Generate and export all validation notices as a json file.
  2. Download the GTFS feed at the URL https://url/to/dataset.zip and name it input.zip
  3. Validate the GTFS data and output the results to the directory located at relative/output/path. Validation results are exported to JSON by default. Please note that since downloading will take time, we recommend validating repeatedly on a local file.