https://github.com/llleeeaaannn/dublinbustracker
https://github.com/llleeeaaannn/dublinbustracker
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/llleeeaaannn/dublinbustracker
- Owner: llleeeaaannn
- License: mit
- Created: 2025-01-05T06:00:55.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-05T07:13:12.000Z (5 months ago)
- Last Synced: 2025-01-05T07:18:13.807Z (5 months ago)
- Language: Python
- Size: 66.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gtfs-upcoming
## What
This consumes a GTFS realtime feed and produces a list of upcoming
buses (and trains, trams, etc.) for a given stops. This list is
served via HTTP in JSON format at /upcoming.json.
/upcoming.json will serve both live (currently operating) and scheduled services
(from the GTFS data). Live data takes precedence over scheduled data for the same
trip. If a stop is near an origin of a service, live data may not yet be
available.
This was developed against the Irish [NTA's GTFS-R feed](https://developer.nationaltransport.ie/api-details#api=gtfsr)
and the [VicRoads Data Exchange GTFS-R feed](https://data-exchange.vicroads.vic.gov.au/api-details#api=vehicle-position-trip-update-opendata&operation=metro-bus-trip-updates).
This is part of a personal project for an live upcoming transit display.
The display previously relied on the now-deprecated SmartDublin RTPI service.
## Usage
```sh
% main.py --config=config.ini --port=6824 --promport=8000 --provider=nta --env=prod
...
2020/08/23 08:58:09 INFO Starting HTTP server on port 6824
```
Then browse to http://127.0.0.1:6824/upcoming.json
### Sample Output
This output is subject to change.
```
{
"current_timestamp":1598471804,
"upcoming":[
{
"trip_id":"ABCDEF",
"route":"7",
"route_type":"BUS",
"headsign":"Bride's Glen Bus Stop - Mountjoy Square Nth",
"direction":"1",
"dueTime":"20:57:01",
"dueInSeconds":17.0,
"source": "LIVE",
},
{
"trip_id":"GHIJKL",
"route":"7A",
"route_type":"BUS",
"headsign":"Loughlinstown Wood Estate - Mountjoy Square Nth",
"direction":"1",
"dueTime":"21:10:33",
"dueInSeconds":829.0,
"source": "SCHEDULE"
}
]
}
```
### Endpoints
Endpoint | Arguments | Notes
-------- | --------- | -----
/upcoming.json | _(none)_ | Shows real-time & scheduled data if Interesting Stops provided.
/upcoming.json | ?stop=123&stop=456 | Shows real-time & scheduled data for stops 123 and 456
/live.json | _(none)_ | Shows just real-time data if Interesting Stops provided
/live.json | ?stop=123&stop=456 | Shows just real-time data for stops 123 and 456
/scheduled.json | _(none)_ | Shows just scheduled data if Interesting Stops provided
/scheduled.json | ?stop=123&stop=456 | Shows just scheduled data for stops 123 and 456
/debugz | _(none)_ | Debug endpoint for GTFS API calls
:8000 | _(none)_ | Prometheus metrics, if --promport is specified
## Build
This project is built with [Bazel](http://bazel.build). If you have bazel,
then building/running is trivial:
```sh
% bazel run :main -- [--config CONFIG] [--gtfs GTFS] [--port PORT] [--provider {nta,vicroads}] [--env {prod,test,metrotrain,tram}]
```
The BUILD file also defines a Debian (.deb) build target.
## Docker
A Dockerfile is provided, which installs the latest master code from github, and the
GTFS-R zip file from the link above. Build the docker file as follows:
``` bash
docker build . --tag tfi_gtfs
```
You run it with a `config.ini` from your project directory as follows:
``` bash
docker run -v ./config.ini:/app/config.ini:ro -p 6824:6824 tfi_gtfs --config=config.ini --env=prod --port=6824 --gtfs=GTFS_Realtime
```
You should now be able to access the API on your local machine.
## Data and Configuration
### GTFS Data
You will need the GTFS dataset (contains definitions for routes, stops,
stop times, and agencies) in order to interpret the realtime data
correctly. This is available from your GTFS-R provider.
For the Irish NTA, that is [here](https://www.transportforireland.ie/transitData/google_transit_combined.zip).
For VicRoads/PTV, that is [here](https://data.ptv.vic.gov.au/downloads/gtfs.zip).
### config.ini
Server configuration is an INI file and has two sections:
1. ApiKeys section: API keys
1. Upcoming section: Interesting Stops
#### API Keys
```
[ApiKeys]
PrimaryApiKey =
SecondaryApiKey =
```
#### (Optional) Interesting Stop Ids
This is _optional_. If specified: gtfs-upcoming will only keep trip and stop
data for the interesting stops. All other trip information will be discarded
at load time.
This is particularly useful for running on low-memory devices (e.g; a
Raspberry Pi). Keeping ~4 nearby stops means the process runs in about ~60M,
versus ~400M for the entire GTFS database.
```
[Upcoming]
InterestingStopIds = 700000000229,700000000240
```