openweathermap

package

v0.0.0-...-c936f35 Latest Latest Go to latest Published: Apr 18, 2024 License: Apache-2.0 Imports: 7 Imported by: 12

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package openweathermap provides weather using the OpenWeatherMap API, available at https://openweathermap.org/api.

This section is empty.

This section is empty.

This section is empty.

type Config string

Config represents open weather map API configuration (just the API key) from which a weather.Provider can be built.

func New(apiKey string) Config

New creates a new OpenWeatherMap API configuration.

func (c Config) CityID(cityID string) weather.Provider

CityID queries OWM by city id. Recommended.

func (c Config) CityName(city, country string) weather.Provider

CityName queries OWM using a named city. Least accurate.

func (c Config) Coords(lat, lon float64) weather.Provider

Coords queries OWM using lat/lon co-ordinates.

func (c Config) Zipcode(zip, country string) weather.Provider

Zipcode queries OWM using a zip code or post code and country.

type Provider string

Provider wraps an open weather map API url so that it can be used as a weather.Provider.

func (owm Provider) GetWeather() (weather.Weather, error)

GetWeather gets weather information from OpenWeatherMap.