Reverse GeoLocate from XMP sidecar files with optional LightRoom DB read
This script will update any of the Country Code, Country, State, City and Location data that is missing in sidecard files. If a Lightroom DB is set, it will read any data from the database and fill in the fields before it tries to get the location name from google with the Latitude and Longitude found in either the XMP sidecar file or the LR database.
The script uses the following external non defauly python libraries
- xmp toolkit
- requests
install both with the pip3 command
pip3 install requests
pip3 install python-xmp-toolkit
XMP Toolkit also needs the Exempi Library. This one can be install via brew or macports directly. See more information for Python XMP Tool kit
reverse_geolocate.py [-h] -i [XMP SOURCE FOLDER [XMP SOURCE FOLDER ...]] [-x [EXCLUDE XMP SOURCE FOLDER [EXCLUDE XMP SOURCE FOLDER ...]]] [-l LIGHTROOM FOLDER] [-s] [-f <overwrite, location, city, state, country, countrycode>] [-d [FUZZY DISTANCE]] [-g GOOGLE API KEY] [-o] [-e EMIL ADDRESS] [-w] [-r] [-u] [-a] [-c] [-n] [-v] [--debug] [--test]
| Argument | Argument Value | Description |
|---|---|---|
| -i, --include-source | XMP sidecar source folder or XMP sidecar file itself | Must given argument. It sets the path where the script will search for XMP sidecar files. It will traverse into subdirectories. A single XMP sidecar file can also be given. If the same file folder combination is found only one is processed. |
| -x, --exclude-source | Folder or File | If given those files and folders will be excluded from work |
| -l, --lightroom | Lightroom DB base folder | The folder where the .lrcat file is located. Optional, if this is set, LR values are read before any Google maps connection is done. Fills the Latitude and Longitude and the location names. Lightroom data never overwrites data already set in the XMP sidecar file. It is recommended to have Lightroom write the XMP sidecar file before this script is run |
| -s, --strict | Do strict check for Lightroom files and include the path into the check | |
| -f, --field | Keyword: overwrite, location, city, state, country, countrycode | In the default no data is overwritten if it is already set. With the 'overwrite' flag all data is set new from the Google Maps location data. Other arguments are each of the location fields and if set only this field will be set. This can be combined with the 'overwrite' flag to overwrite already set data |
| -d, --fuzzy-cache | distance | Allow fuzzy cache lookup with either default value of 10m or an override value in m or km |
| -n, --nobackup | Do not create a backup of XMP sidecar file when it is changed | |
| -o, --openstreetmap | Use OpenStreetMap instead of the default google maps | |
| -e, --email | email address | For OpenStreetMap with a large number of access |
| -g, --google | Google Maps API Key | If available, to avoid the access limitations to the reverse location lookup |
| -r, --read-only | Read only data from the XMP files and print them out. No LR DB connection is done or any map lookups | |
| -u, --unset-only | Only list XMP files with missing data | |
| -a, --no-autoadjust | Do not try to auto adjust column width to terminal column width | |
| -c, --compact | Do extra compact view | |
| -w, --write-settings | Write the Google API key or the OpenStreetMap email into the settings file | |
| -v, --verbose | More verbose output. Currently not used | |
| --debug | Full detailed debug output. Will print out alot of data | |
| --test | Does not write any changed back to the XMP sidecar file. For testing purposes |
The script will created a backup of the current sidecar file named .BK.xmp in the same location as the original file.
If the Lightroom lookup is used without the --strict argument and several files with the same name are found, they will be skipped for usage.
reverse_geolocate.py -i Photos/2017/01 -i Photos/2017/02 -l LightRoom/MyCatalogue -f overwrite -g <API KEY>
Will find all XMP sidecar files in both folders Photos/2017/01 and Photos/2017/02 and all folder below it. Uses the Lightroom database at LightRoom/MyCatalogue. The script will overwrite all data, even if it is already set
reverse_geolocate.py -i Photos/2017/01 -i Photos/2017/02 -x Photos/2017/02/Folder\ A -x Photos/2017/01/Folder\ B/some_file.xmp -l LightRoom/MyCatalogue
Will exlucde "Photos/2017/02/Folder A" from processing. For -x also a file (including the .xmp extension) can be given.
reverse_geolocate.py -i Photos/2017/01/Event-01/some_photo.xmp -f location
Only works on some_photo.xmp file and will only set the location field if it is not yet set.
The Google Maps API key and the OpenStreetMap Email address can be written to a config file with the -w argument. The config file is located in $HOME/.config/reverseGeolocate/reverse_geolocate.cfg in the following format
[API]
googleapikey = <google api key>
openstreetmapemail = <email>
if no -g or -e flag is given the keys are read from the config file. If the -g or -e parameter is given it will override the one found in the config file. A new parameter can be written to this config file with -w parameter.
If the same GPS coordinate is detected no other API maps call is done. With the fuzzy-distance argument this can be further extended to certain distances for each GPS coordinate from each other. The default value is 10m and can be overriden with an value to the argument.
Can be used to force cache on GPS coordinates that are very close to each other but not exactly the same.
Based in the JSON return data the following fields are set in order. If one can not be found for a target set, the next one below is used
| order | type | target set |
|---|---|---|
| 1 | country | Country, CountryCode |
| 2 | administrative_area_level_1 | State |
| 3 | administrative_area_level_2 | State |
| 4 | locality | City |
| 5 | sublocality_level_1 | Location |
| 6 | sublocality_level_2 | Location |
| 7 | route | Location |
| order | type | target set |
|---|---|---|
| 1 | country_code | CountryCode |
| 2 | country | Country |
| 3 | state | State |
| 4 | city | City |
| 5 | city_district | City |
| 6 | state_district | City |
| 7 | county | Location |
| 8 | town | Location |
| 9 | suburb | Location |
| 10 | hamlet | Location |
| 11 | neighbourhood | Location |
| 12 | raod | Location |
After the script is done the following overview will be printed
========================================
XMP Files found : 57
Updated : 3
Skipped : 54
New GeoLocation from Map : 2
GeoLocation from Cache : 1
GeoLocation from Fuzzy Cache : 0
Failed reverse GeoLocate : 0
GeoLocaction from Lightroom : 1
No Lightroom data found : 46
More than one found in LR : 0
If there are problems with getting data from the Google Maps API the complete errior sting will be printed
...
---> Photos/2017/02/some_file.xmp: Error in request: OVER_QUERY_LIMIT You have exceeded your daily request quota for this API. We recommend registering for a key at the Google Developers Console: https://console.developers.google.com/apis/credentials?project=_
(!) Could not geo loaction data [FAILED]
...
Also the files that could not be updated will be printed at the end of the run under the stats list
...
----------------------------------------
Files that failed to update:
Photos/2017/02/some_file.xmp
This script has only been tested on macOS