github.com/exybore/goweather

goweather

🌦 Easily fetch weather information using Go and the OpenWeatherMap API.

• 🔧 Installation
• ⌨ Usage
  • Initializing the API
  • Get current weather
  • Get forecast
• 📜 Credits
• 🔐 License

🔧 Installation

First of all, make sure you have Go 1.12 installed on your system.

Install the library using go get...

go get github.com/exybore/goweather

... or use whatever dependency manager you like! Then, you can start writing your code !

⌨ Usage

Initializing the API

Before continuing, head over to openweathermap.org and grab an API key. It's free up to 60 requests per minute, which is pretty comfortable.

After this step, you're ready to initialize the API using the goweather.NewAPI function :

package main

import "github.com/exybore/goweather"

func main() {
  api, err := goweather.NewAPI("ez5e4fz44e84fg89ze8", "en", "metric")
  if err != nil {
    panic(err)
  }
}

This function takes three parameters :

• the API token that you generated using your account on openweathermap.org
• the language to use. It can be one of these Arabic - ar, Bulgarian - bg, Catalan - ca, Czech - cz, German - de, Greek - el, English - en, Persian (Farsi) - fa, Finnish - fi, French - fr, Galician - gl, Croatian - hr, Hungarian - hu, Italian - it, Japanese - ja, Korean - kr, Latvian - la, Lithuanian - lt, Macedonian - mk, Dutch - nl, Polish - pl, Portuguese - pt, Romanian - ro, Russian - ru, Swedish - se, Slovak - sk, Slovenian - sl, Spanish - es, Turkish - tr, Ukrainian - ua, Vietnamese - vi, Chinese Simplified - zh_cn, Chinese Traditional - zh_tw
• the unit system. It can be one of these :
  • default (temperatures in Kelvin)
  • metric (temperatures in Celsius)
  • imperial (temperatures in Fahrenheit)

Get current weather

To get the current weather, use the Current method of the API :

  weather, err := api.Current("Lyon,FR")
  if err != nil {
    panic(err)
  }

You can use any existing location in the parameter, but it's recommended to use the City,Country code format so the result is 100% accurate.

The method returns a types.Current structure that you can explore on GoDoc

Get forecast

To get the forecast, use the Forecast method of the API :

  weather, err := api.Forecast("Lyon,FR")
  if err != nil {
    panic(err)
  }

You can use any existing location in the parameter, but it's recommended to use the City,Country code format so the result is 100% accurate.

The method returns a types.Forecast structure that you can explore on GoDoc

📜 Credits

• Service : OpenWeatherMap
• Maintainer : Exybore

🔐 License

MIT License

Copyright (c) 2019 Exybore

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.