Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kashifkhan0771/go-weather
Weather API Client
https://github.com/kashifkhan0771/go-weather
api-client api-client-go go golang http-api weather-api weather-apis
Last synced: 7 days ago
JSON representation
Weather API Client
- Host: GitHub
- URL: https://github.com/kashifkhan0771/go-weather
- Owner: kashifkhan0771
- License: mit
- Created: 2024-04-22T15:31:52.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-12-10T05:31:48.000Z (about 1 month ago)
- Last Synced: 2024-12-10T06:26:39.331Z (about 1 month ago)
- Topics: api-client, api-client-go, go, golang, http-api, weather-api, weather-apis
- Language: Go
- Homepage: https://www.weatherapi.com/docs/
- Size: 11.7 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Go API Weather
[](https://golang.org/)
[](LICENSE)
Go-Weather is a simple and efficient Go library for fetching weather information from [WeatherAPI](https://www.weatherapi.com). This library allows developers to seamlessly integrate weather data into their applications.
## Features
- Fetch current weather for any location.
- Retrieve forecast data for up to 7 days.
- Supports WeatherAPI integration for reliable weather data.
- Lightweight
## Installation
In order to use Go-Weather, you need to have Go installed on your system. The library requires Go version 1.22.0 or higher.
```shell
go get github.com/kashifkhan0771/go-weather
```
## Usage
Import the library in your Go application:
```go
package main
import (
"fmt"
"github.com/kashifkhan0771/go-weather"
)
func main() {
client := weather.NewClient("YOUR_API_KEY")
currentWeather, err := client.GetCurrentWeather("London")
if err != nil {
fmt.Println("Error fetching weather:", err)
return
}
fmt.Printf("Current temperature in London: %f°C\n", currentWeather.Temperature)
}
```
## Configuration
Set up your client with the API key provided by the weather service:
```go
client := weather.NewClient("YOUR_API_KEY")
```
### Advanced Congiguration
Configure the client with additional options (if available):
```go
client := weather.NewClient(
"YOUR_API_KEY",
weather.WithTimeout(10*time.Second),
)
```
## Supported Functions
### GetCurrentWeather
```go
func GetCurrentWeather(location string) (*Weather, error)
```
Fetches current weather for a given location.
Parameters:
- `location`: City name, postal code, or coordinates
Returns:
- `*Weather`: Weather information including temperature, conditions, etc.
- `error`: API errors, network issues, or invalid location
### GetForecast
```go
func GetForecast(location string, days int) (*Forecast, error)
```
Retrieves weather forecast for specified days.
Parameters:
- `location`: City name, postal code, or coordinates
- `days`: Number of days (1-7)
Returns:
- `*Forecast`: Forecast information for requested days
- `error`: API errors, network issues, or invalid parameters
## Examples
Detailed usage examples for each function are provided in the [EXAMPLES.md](EXAMPLES.md) file.
## Contributing
Contributions are welcome! Please follow the steps below:
- Fork the repository.
- Create a feature branch: git checkout -b feature-name.
- Commit your changes: git commit -m 'Add new feature'.
- Push to your branch: git push origin feature-name.
- Open a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/kashifkhan0771/go-weather/blob/main/LICENSE) file for details.
## Acknowledgments
Thanks to WeatherAPI for data integration.