placekey

placekey-go

A Go library for working with Placekeys. This is an unofficial port of the Python library placekey-py and is not affiliated with the Placekey project.

Status

This library port is mostly complete. A client interface to the Placekeys API is also included. Some geospatial features are currently under development, namely getting a Placekey from a Polygon, WKT or GeoJSON.

Usage

Prerequisites

This library depends on uber/h3-go and inherits the same prerequisites. It requires CGO (CGO_ENABLED=1) in order to be built.

If you see errors/warnings like "build constraints exclude all Go files...", then the cgo build constraint is likely disabled; try setting CGO_ENABLED=1 environment variable for your build step.

Installation

golang/cmd/go

go get github.com/engelsjk/placekey-go

Quickstart

import "github.com/engelsjk/placekey-go"

func ExampleFromGeo() {
    placekey.FromGeo(37.23712, -115.80187)
    // Output:
    // @5ys-rsx-4jv
}

func ExampleToH3() {
    placekey.ToH3("@5yv-j8h-3nq")
    // Output:
    // 8a2986b843b7fff
}

func ExampleDistance() {
    placekey.Distance("@5ys-rsx-4jv", "@5yv-j8h-3nq")
    // Output:
    // 138681.552855
}

func ExampleGeoJSON() {
    placekey.ToGeoJSON("@5yv-j8h-3nq")
    // Output:
    // {"type":"Feature","geometry":{"type":"Polygon","coordinates":[...]},"properties":null}
}

func ExampleDistance() {
    placekey.ToWKT("@5yv-j8h-3nq")
    // Output:
    // POLYGON(...)
}

Dependencies

• uber/h3-go