README
¶
go-gtfs
Load GTFS files in Go.
The project is in maintenance mode.
It is kept compatible with changes in the Go ecosystem but no new features will be developed. PR could be accepted.
Install
go get github.com/artonge/go-gtfs
Examples
Load one directory containing GTFS files:
path/to/gtfs_files
├── agency.txt
├── calendar_dates.txt
├── calendar.txt
├── routes.txt
├── stops.txt
├── stop_times.txt
├── transfers.txt
└── trips.txt
g, err := gtfs.Load("path/to/gtfs_files", nil)
Load a directory containing sub directories containing GTFS files:
path/to/gtfs_directories
├── gtfs1
│ ├── agency.txt
│ ├── calendar_dates.txt
│ ├── routes.txt
│ ├── stops.txt
│ ├── stop_times.txt
│ ├── transfers.txt
│ └── trips.txt
└── gtfs2
├── agency.txt
├── calendar_dates.txt
├── calendar.txt
├── routes.txt
├── stops.txt
├── stop_times.txt
├── transfers.txt
└── trips.txt
gs, err := gtfs.LoadSplitted("path/to/gtfs_directories", nil)
You can then access the data through the GTFS structure. That structure contains arrays of approriate structures for each files.
type GTFS struct {
Path string // The path to the containing directory
Agency Agency
Routes []Route
Stops []Stop
StopsTimes []Stop
Trips []Trip
Calendars []Calendar
Transfers []Transfer
}
type Route struct {
ID string `csv:"route_id"`
AgencyID string `csv:"agency_id"`
ShortName string `csv:"route_short_name"`
LongName string `csv:"route_long_name"`
Type int `csv:"route_type"`
Desc string `csv:"route_url"`
URL string `csv:"route_desc"`
Color string `csv:"route_color"`
TextColor string `csv:"route_text_color"`
}
...
Contributions
Pull requests are welcome ! :)
Documentation
¶
Index ¶
Constants ¶
const ( RouteTypeTram = 0 RouteTypeSubway = 1 RouteTypeRail = 2 RouteTypeBus = 3 RouteTypeFerry = 4 RouteTypeCableCar = 5 RouteTypeGondola = 6 RouteTypeFunicular = 7 ExceptionTypeAdded = 1 ExceptionTypeRemoved = 2 )
Const used in GTFS
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Agency ¶
type Agency struct {
ID string `csv:"agency_id"`
Name string `csv:"agency_name"`
URL string `csv:"agency_url"`
Timezone string `csv:"agency_timezone"`
Langue string `csv:"agency_lang"`
Phone string `csv:"agency_phone"`
}
Agency -
type Calendar ¶
type Calendar struct {
ServiceID string `csv:"service_id"`
Monday int `csv:"monday"`
Tuesday int `csv:"tuesday"`
Wednesday int `csv:"wednesday"`
Thursday int `csv:"thursday"`
Friday int `csv:"friday"`
Saturday int `csv:"saturday"`
Sunday int `csv:"sunday"`
Start string `csv:"start_date"`
End string `csv:"end_date"`
}
Calendar -
type CalendarDate ¶
type CalendarDate struct {
ServiceID string `csv:"service_id"`
Date string `csv:"date"`
ExceptionType int `csv:"exception_type"`
}
CalendarDate -
type GTFS ¶
type GTFS struct {
Path string // The path to the containing directory
Agency Agency
Agencies []Agency
Routes []Route
Shapes []Shape
Stops []Stop
StopsTimes []StopTime
Trips []Trip
Calendars []Calendar
CalendarDates []CalendarDate
Transfers []Transfer
}
GTFS -
func Load ¶
Load - load GTFS files @param dirPath: the directory containing the GTFS @param filter: It is possible to partialy load the gtfs files If you don't want to load all the files, add an param to the Load function containing only the files that must be loaded Example: Load("path/to/gtfs", map[string]bool{"routes": true}) @return a filled GTFS or an error
func LoadSplitted ¶
LoadSplitted - load splitted GTFS files ==> When GTFS are splitted into sub directories @param dirPath: the directory containing the sub GTFSs @param filter: see Load function @return an array of filled GTFS or an error
type Route ¶
type Route struct {
ID string `csv:"route_id"`
AgencyID string `csv:"agency_id"`
ShortName string `csv:"route_short_name"`
LongName string `csv:"route_long_name"`
Type int `csv:"route_type"`
Desc string `csv:"route_url"`
URL string `csv:"route_desc"`
Color string `csv:"route_color"`
TextColor string `csv:"route_text_color"`
}
Route -
type Shape ¶ added in v1.1.2
type Shape struct {
ID string `csv:"shape_id"`
Lat float64 `csv:"shape_pt_lat"`
Long float64 `csv:"shape_pt_lon"`
Seq int `csv:"shape_pt_sequence"`
Distance float64 `csv:"shape_dist_traveled"`
}
Shape -
type Stop ¶
type Stop struct {
ID string `csv:"stop_id"`
Code string `csv:"stop_code"`
Name string `csv:"stop_name"`
Description string `csv:"stop_desc"`
Latitude float64 `csv:"stop_lat"`
Longitude float64 `csv:"stop_lon"`
Type string `csv:"location_type"`
Parent string `csv:"parent_station"`
}
Stop -
type StopTime ¶
type StopTime struct {
StopID string `csv:"stop_id"`
StopSeq string `csv:"stop_sequence"`
StopHeadSign string `csv:"stop_headsign"`
TripID string `csv:"trip_id"`
Shape float64 `csv:"shape_dist_traveled"`
Departure string `csv:"departure_time"`
Arrival string `csv:"arrival_time"`
}
StopTime -
Source Files