osmshortlink

README

osmshortlink-go: Go module and command-line tool for creating, encoding & decoding of OpenStreetMap shortlinks

Specification: https://wiki.openstreetmap.org/wiki/Shortlink

Usage

Creating a link in Go

package main

import "github.com/stefanb/osmshortlink-go"

func main() {
	shortlink, err := osmshortlink.Create(46.05141, 14.50604, 17)
	if err != nil {
		panic(err)
	}
	print(shortlink)
}

Prints: https://osm.org/go/0Ik3VNr_A-?m

Try it in Go playground

Command-line tool

Installation

Download the pre-built binaries

Download the pre-built binaries for your platform from latest release.

Install using Go

$ go install github.com/stefanb/osmshortlink-go/cmd/osmshortlink@latest
$ osmshortlink 46.05141 14.50604 17
https://osm.org/go/0Ik3VNr_A-?m

Run using Go without installing

$ go run github.com/stefanb/osmshortlink-go/cmd/osmshortlink@latest 46.05141 14.50604 17
https://osm.org/go/0Ik3VNr_A-?m

Pre-built binaries

You can download pre-built binaries for various platforms from latest release.

Usage: osmshortlink [latitude] [longitude] [zoom]

For example:

$ osmshortlink 46.05141 14.50604 17
https://osm.org/go/0Ik3VNr_A-?m

Development

Run: go run ./cmd/osmshortlink/main.go 46.05141 14.50604 17

Testing: go test -v -race -cover ./...

Fuzz testing: go test -fuzz=. -fuzztime=1m

Documentation

Overview

Creating OpenStreetMap short links, see https://wiki.openstreetmap.org/wiki/Shortlink

Index

• Constants
• func Create(latitude float32, longitude float32, zoom int) (string, error)
• func Decode(s string) (float64, float64, int, error)
• func Encode(latitude float32, longitude float32, zoom int) (string, error)

Examples

• Create
• Decode
• Encode

Constants

const (
	BASE_SHORT_OSM_URL = "https://osm.org/go/"
)

Functions

func Create

func Create(latitude float32, longitude float32, zoom int) (string, error)

Create a short link to OSM map with marker at he given position and zoom

Example

shortLink, err := osmshortlink.Create(46.05141, 14.50604, 17)
if err != nil {
	panic(err)
}
fmt.Println(shortLink)

Output:

https://osm.org/go/0Ik3VNr_A-?m

func Decode

func Decode(s string) (float64, float64, int, error)

Decode a short string into a location and zoom.

Example

latitude, longitude, zoom, err := osmshortlink.Decode("0Ik3VNr_A-")
if err != nil {
	panic(err)
}
fmt.Println(latitude, longitude, zoom)

Output:

46.05140447616577 14.506051540374756 17

func Encode

func Encode(latitude float32, longitude float32, zoom int) (string, error)

Encode a location and zoom, return a short string representing it.

Example

shortLink, err := osmshortlink.Encode(46.05141, 14.50604, 17)
if err != nil {
	panic(err)
}
fmt.Println(shortLink)

Output:

0Ik3VNr_A-