https://github.com/amwolff/google-gtfs-realtime-tools

Build servers that push or serve GTFS Realtime feeds for Google
https://github.com/amwolff/google-gtfs-realtime-tools

google google-api google-maps gtfs gtfs-realtime transit transit-agencies

Last synced: 23 days ago
JSON representation

Build servers that push or serve GTFS Realtime feeds for Google

• Host: GitHub
• URL: https://github.com/amwolff/google-gtfs-realtime-tools
• Owner: amwolff
• License: mit
• Created: 2020-02-09T11:22:04.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-02-23T13:59:14.000Z (over 4 years ago)
• Last Synced: 2024-06-20T19:24:39.340Z (5 months ago)
• Topics: google, google-api, google-maps, gtfs, gtfs-realtime, transit, transit-agencies
• Language: Go
• Homepage:
• Size: 43.7 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Go tools to interact with the Google Transit APIs

=================================================

[![GoDoc](https://godoc.org/github.com/amwolff/google-gtfs-realtime-tools?status.svg)](https://godoc.org/github.com/amwolff/google-gtfs-realtime-tools)

[![Build Status](https://travis-ci.org/amwolff/google-gtfs-realtime-tools.svg?branch=master)](https://travis-ci.org/amwolff/google-gtfs-realtime-tools)

## Overview

Live Transit Updates is a feature within Google Maps that provides users with realtime transit information.

GTFS Realtime is a data exchange format consumed by the Google Transit APIs.

The code here aims to make it easier to push or make Google fetch such feed, enabling the feature.

## Getting started

The easiest way to start is to implement the [`FeedProvider`](https://github.com/amwolff/google-gtfs-realtime-tools/blob/master/provider/provider.go) interface.

### Push

```go

package main

import (

	"net/http"

	"os"

	"github.com/amwolff/google-gtfs-realtime-tools/oauth"

)

func main() {

	httpClient := &http.Client{}

	f, err := os.Open("a/path/to/client_secrets.JSON")

	if err != nil {

		panic(err)

	}

	defer f.Close()

	c, err := oauth.NewClient(

		httpClient,

		f,

		"a/path/to/where/cache/.tokens.JSON",

		oauth.DefaultTokenExchangeURL,

		"YOUR_AUTHORIZATION_CODE",

		oauth.DefaultFeedUploadURL)

	if err != nil {

		panic(err)

	}

	p := ADataSourceThatImplementsFeedProvider{...}

	if err := c.Run(p, "feed.pb", "YOUR_ALKALI_ACCOUNT_ID", "YOUR_REALTIME_FEED_ID"); err != nil {

		panic(err)

	}

}

```

You can also use the `UploadFeedMessage` method to have more control over the process.

### Fetch

```go

package main

import (

	"log"

	"net/http"

	"github.com/amwolff/google-gtfs-realtime-tools/fetch"

)

func main() {

	p := ADataSourceThatImplementsFeedProvider{...}

	h := fetch.NewWithCache(p)

	if err := http.ListenAndServe(":http", h); err != nil {

		log.Println(err)

	}

	log.Println("Begin serving your feed on all interfaces at HTTP port")

}

```

Although *push* seems more modern and sophisticated I strongly encourage you to use the *fetch* model, especially if you are a public transportation agency.

This way not only Google can fetch realtime transit data but also people like me.

Opening your data creates opportunities to build better working cities and, of course, the world.

I hope the docs and examples speak for themselves but if anything seems unclear - feel free to contact me or open an issue here.

Working examples can be found [here](https://github.com/amwolff/google-gtfs-realtime-tools/tree/master/cmd).