hanayo/vendor/github.com/pariz/gountries
2019-02-23 13:29:15 +00:00
..
data replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
.gitignore replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
bindata.go replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
country_test.go replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
country.go replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
error.go replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
gountries.go replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
LICENSE replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
license.txt replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
math_test.go replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
math.go replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
query_test.go replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
query.go replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
readme.md replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
setup.go replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
subdivision_test.go replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
subdivision.go replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00
wercker.yml replace zxq.co/ripple/hanayo 2019-02-23 13:29:15 +00:00

gountries

wercker status codecov.io Go Report Card

Inspired by the countries gem for ruby.

Countries (ISO-3166-1), Country Subdivisions(ISO-3166-2), Currencies (ISO 4217), Geo Coordinates(ISO-6709) as well as translations, country borders and other stuff exposed as struct data.

All data is derived from the pariz/countries repo.

This is currently a work in progress, so things may change. More stuff will be added

Installation

go get github.com/pariz/gountries

Examples

Basic


import (
  "github.com/pariz/gountries"
  "fmt"
)


query := gountries.New()

/////////////////
// Find sweden //
/////////////////

sweden, _ := query.FindCountryByName("sweden")
// sweden, _ := query.FindCountryByAlpha("SE")
// sweden, _ := query.FindCountryByAlpha("SWE")

fmt.Println(sweden.Name.Common) // Output: Sweden
fmt.Println(sweden.Name.Official) // Output: Konungariket Sverige

fmt.Println(sweden.Translations["DEU"].Common) // Output: Schweden
fmt.Println(sweden.Translations["DEU"].Official) // Output: Königreich Schweden


A bit more advanced


import (
  "github.com/pariz/gountries"
  "fmt"
)

query := gountries.New()

////////////////////////////////////////////
// Find the bordering countries of Sweden //
////////////////////////////////////////////

sweden, _ := query.FindCountryByAlpha("SWE") // "SE" also works..

// Get the bordering countries of sweden
for _, country := range sweden.BorderingCountries() {
	fmt.Println(country.Name.Common)
}

// Output:
// Finland
// Norway

////////////////////////////////////
// Find all subdivisons for Sweden //
////////////////////////////////////

subdivisions := sweden.SubDivisions()

for _, subdivision := range subdivisions {
	fmt.Println(subdivision.Name)
}

// Output:
// Västerbottens län
// Uppsala län
// Södermanlands län
// Gotlands län
// Dalarnas län
// ...

//////////////////////////////////////////////////////////
// Find all countries bordering Germany and Switzerland //
//////////////////////////////////////////////////////////

countryQuery := Country{
	Borders: []string{
		"DEU",
		"CHE",
	},
}

countries := query.FindCountries(countryQuery)

for _, c := range countries {
	fmt.Println(c.Name.Common)
}

// Output:
// Austria
// France

///////////////////////////////////////////////////////////////////
// Calculate distance between Sweden and Germany (in Kilometers) //
///////////////////////////////////////////////////////////////////

se, _ := query.FindCountryByAlpha("SWE")
de, _ := query.FindCountryByAlpha("DEU")

distance := gountries.MeasureDistanceHaversine(se, de)
//distance := MeasureDistancePythagoras(se, de)

fmt.Println(distance)

// Output:
// 1430.1937864547901

distance = gountries.CalculateHaversine(
	se.Coordinates.MaxLatitude, se.Coordinates.MaxLongitude,
	de.Coordinates.MinLatitude, de.Coordinates.MinLongitude)

fmt.Println(distance)

// Output:
// 2641.26145088825


Using packed data

The data in the data/yaml subdirectory is embedded using go-bindata. Once you include this library in your project, you won't need to access the data directory. To add or update the data, make changes to the YAML files then run:

go-bindata -pkg gountries data/yaml/*

Testing

Has a pretty solid test coverage but is constantly improving.

Todo

  • Province/County querying (partially complete)
  • Measurement between coordinates
  • GeoJSON information
  • Suggestions?