Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theovidal/goweather
🌦 Fetch the weather using Go and the OpenWeatherMap API
https://github.com/theovidal/goweather
golang golang-library openweathermap openweathermap-api weather
Last synced: about 2 months ago
JSON representation
🌦 Fetch the weather using Go and the OpenWeatherMap API
- Host: GitHub
- URL: https://github.com/theovidal/goweather
- Owner: theovidal
- License: mit
- Created: 2019-08-24T11:51:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-01T11:49:48.000Z (about 4 years ago)
- Last Synced: 2024-10-22T03:13:46.207Z (3 months ago)
- Topics: golang, golang-library, openweathermap, openweathermap-api, weather
- Language: Go
- Size: 48.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# goweather
**🌦 Easily fetch weather information using Go and the OpenWeatherMap API.**
[](https://codecov.io/gh/theovidal/goweather)
[](https://circleci.com/gh/theovidal/goweather)
[](https://travis-ci.org/theovidal/goweather)
[](./LICENSE)
[](https://app.codacy.com/app/theovidal/goweather?utm_source=github.com&utm_medium=referral&utm_content=theovidal/goweather&utm_campaign=Badge_Grade_Dashboard)
[](https://goreportcard.com/report/github.com/theovidal/goweather)
[](https://godoc.org/github.com/theovidal/goweather)
[](https://github.com/theovidal/goweather/releases)
[](https://github.com/theovidal/goweather)
[](https://github.com/theovidal/goweather/issues)
- [🔧 Installation](#-installation)
- [⌨ Usage](#-usage)
- [Initializing the API](#initializing-the-api)
- [Get current weather](#get-current-weather)
- [Get forecast](#get-forecast)
- [More examples](#more-examples)
- [💻 Developing](#-developing)
- [📜 Credits](#-credits)
- [🔐 License](#-license)
## 🔧 Installation
First of all, make sure you have Go 1.12 or earlier installed on your system.
Install the library using `go get`...
```bash
go get github.com/theovidal/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](https://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 :
```go
package main
import "github.com/theovidal/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 :
```go
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](https://godoc.org/github.com/exybore/goweather/types#Current)
### Get forecast
To get the forecast, use the `Forecast` method of the API :
```go
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](https://godoc.org/github.com/exybore/goweather/types#Forecast)
### More examples
Check the [examples file](examples_test.go) for more examples of scripts using the goweather library.
## 💻 Developing
Thank you for being interested in goweather's development ! Please follow these steps :
- [Fork the repository](https://github.com/exybore/goweather/fork) on your profile
- Clone it on your computer and install the required dependencies using the `go get` command
- Make your changes
- Write tests and execute them using the `go test` command. Your API key must be stored in a `WEATHER_API_KEY` environment variable
- Commit and push your work
- Open a pull request and explain why you made these changes
## 📜 Credits
- Service : [OpenWeatherMap](https://openweathermap.org)
- Maintainer : [Théo Vidal](https://github.com/theovidal)
## 🔐 License
[MIT License](./LICENSE)