Routing from origin destination file with REST API services

Purpose

This script automatize the requests to online services to calculate shortest or quickest routes form origin to destination.

The supported services are tomtom and openrouteservice. They both require a registration to get an API key. They offer various plans, including a free plan.

It is also possible to install a local version of openrouteservice using a subset of the underlying OpenStreeMap dataset on your area of interest.

Quick start

route.py --start 0.0 0.0 --end 0.0 0.0 --routing tomtom --out myfile.txt

route.py --infile myfile.txt --routing tomtom --out myfile.txt
reads start and end coordinates in a csv file with id,startlat,startlon,endlat,endlon

Set up

1. Prerequisite:
   python 3 and above and the libraries used by the script:

tested with:
geopandas==0.14.3
numpy==1.26.4
pandas==2.2.1
Requests==2.31.0
Shapely==2.0.3

3. Get an API key from the REST routing service and then save it in a text file under /any/path/to/api-key-textfile.txt

4. check that output folders exist python route.py --check
   The --check parameter will display all parameters on the standard output.

You can check that everything works using the following command line :
python route.py --api-key /any/path/to/api-key-textfile.txt --route