united-drivers / postal

:postbox: international postal address normalizer and renderer

postal

📮 international postal address normalizer and renderer

Usage

Install with go get github.com/united-drivers/postal

import "github.com/united-drivers/postal"

address := postal.Address{
    HouseNumber:  "96",
	Road:         "Boulevard Bessières",
	Suburb:       "Épinettes",
	CityDistrict: "17th Arrondissement",
	County:       "Paris",
	State:        "Ile-de-France",
	Country:      "France",
	PostCode:     "75017",
	CountryCode:  "fr",
}

fmt.Println(address.Short()) // 96 Boulevard Bessières, Paris
fmt.Println(address.Long())  // 96 Boulevard Bessières 75017 Paris, France
fmt.Println(address.Full())  // 96, Boulevard Bessières, Épinettes, 17th Arrondissement, Paris, Ile-de-France, 75017, France

More usage on GoDoc, or in the test file.

License

Apache 2.0

postal's Issues

Add examples in the README

Add Belgium rules

Add letter output renderer

Add shortening for French addresses

Using https://github.com/united-drivers/go-normadresse

Falsehoods

The hoods: https://github.com/kdeldycke/awesome-falsehood#postal-addresses
Good implementation example: https://github.com/scaleway/postal-address

Add Spain rules