Developer documentation
Closed this issue · 5 comments
We need documentation on how the script is technically structured, how to extend the script and how to make it work for other cities and other type of schedule information. I suggest to use the wiki here in this github repo.
@marcosfede when adapting osm2gtfs for your own region, you need to provide your own creators for routes, stops and trips. Have a look at the creators folder. There you have (incomplete) default implementations for those creators and a fenix folder where specific creators for the fenix transport agency are stored.
Essentially, these merge the data retrieved from OSM with schedule data that you have to provide yourself. Normally, schedules are published somewhere, ideally in a machine readable format. Many people scrape websites as well to get the schedules.
You would start by taking the example config file and adapt it to your region. Then you can run the script to fetch and cache data from OSM. Based on that data you can then work on combining it with the schedule information similar to how it is done for fenix. Another example you can look at is the incofer agency from Costa Rica which is not yet merged.
Sounds good. I'll take a look at this in the following days If I can get the data from somewhere. Thanks!
I just added some documentation:
Thanks @xamanu !!!
I guess we can close this one here.