taginfo_to_gsheet v1.0.1

TagInfo to Google Sheets

A script to get information from the Open Street Map TagInfo API and append it to a Google Sheet for further presentation.

Intended to be run as a cronjob on a daily basis.

Installation

You need npm to install. This is bundled as part of node.js.

npm i -g taginfo_to_gsheet

Usage

taginfo_to_gsheet <googleSheetsCredentials> <tagInfoSearch>

• googleSheetsCredentials
  • Path to Google provided credentials file (for accessing Google APIs)
• tagInfoSearch
  • Path to file containing tagInfo search data in JSON format.

Format of tagInfo search data

[
    {
        "tag_info": [
            {"name": "oneway", "key": "oneway", "value": "yes"}
        ],
        "google_sheet_id": "<sheet-id-goes-here>",
        "worksheet_number": 0
    }
]

• tag_info
  • An array of searches that you'd like to perform.
• google_sheet_id
  • The id (as found in the last part of the google sheet's URL)
  • Ensure the sheet has the following columns date, tag, all, nodes, ways, relations
• worksheet_number
  • E.g. 0 for the first worksheet, 1 for the second etc

Options for tag_info searches

• {"name": "food standards", "key": "fhrs:id"}

  • search for instances of the key fhrs:id

• {"name": "oneway", "key": "oneway", "value": "yes"}

  • search for oneway=yes

• {"name": "paths and footways", "key": "highway", "values": ["path","footway"]}

  • search for database entries (nodes, ways, relations) that match highway=path or highway=footway

• {"name": "need fixing", "keys": ["fixme", "FIXME"]}

  • search for instances of the key fixme or FIXME

• {"name": "designations", "key": "designation", "values": ["public_footpath","public_bridleway"], "matches_key": "highway"}

  • searches for designation=public_footpath or designation=public_bridleway that appear on highway=*

• {"name": "designations for footpaths", "key": "designation", "values": ["public_footpath","public_bridleway"], "matches_key": "highway", "matches_values": ["footway","path"]}

  • searches for designation=public_footpath or designation=public_bridleway that appear on either highway=footway or highway=path

Multiple searches

You can run multiple searches in 2 ways.

• Firstly you can have many values for "tag_info" and they will all be added to consecutive lines in the google sheet
• Secondly you can have multiple entries, each with their own google_sheet_id and worksheet number.

In the following example "oneway" and "paths and footways" both go on the same sheet, and "need fixing" goes on a different worksheet.

[
    {
        "tag_info": [
            {"name": "oneway", "key": "oneway", "value": "yes"},
            {"name": "paths and footways", "key": "highway", "values": ["path","footway"]}
        ],
        "google_sheet_id": "<sheet-id-goes-here>",
        "worksheet_number": 0
    },
    {
        "tag_info": [
            {"name": "need fixing", "keys": ["fixme", "FIXME"]}
        ],
        "google_sheet_id": "<sheet-id-goes-here>",
        "worksheet_number": 1
    }
]

Creating a Google Service Account

• Create / Activate a Google Developer account
• In the Google Dashboard, create a new project
• Activate the Google Sheets API for that project
• With the Google Sheets API selected, create a Service account.
• Edit the service account and add a key to it.
• When adding a key, there is a JSON option, choose this and that's the file you'll need.
• Add the email of the service account to the sheet you'd like to add to by 'inviting' them to edit the sheet.

Development

If you are working locally with this repo, then use npm link to create the taginfo_to_gsheet binary from the local source code (and use npm unlink to clean up afterwards)