pyaustine / weather-api-wrapper

A Python wrapper for the OpenWeatherMap API, enabling easy access to weather data for any location.
https://pypi.org/project/weather-api-wrapper/
MIT License
1 stars 0 forks source link
openweathermap-api python weather-api-wrapper wrapper-api

Weather API Wrapper

License GitHub release (latest by date) GitHub last commit GitHub issues GitHub pull requests

A Python wrapper for the OpenWeatherMap API, enabling easy access to weather data for any location.

Installation

You can install the Weather API Wrapper using pip:

pip install weather-api-wrapper

Features

Usage

from weather_api_wrapper import WeatherClient

# Initialize the WeatherClient with your OpenWeatherMap API key
client = WeatherClient(api_key='your_api_key')

# Get current weather for a specific city
current_weather = client.get_current_weather(city='London')

# Get weather forecast for a specific city
forecast = client.get_weather_forecast(city='New York')

# Get historical weather data for a specific city and date range
historical_data = client.get_historical_weather(city={'lat': 51.51, 'lon': -0.13}, start_date='2024-04-01', end_date='2024-04-07')

# Get air pollution data for a specific city
air_pollution = client.get_air_pollution(city={'lat': 51.51, 'lon': -0.13})

# Get UV index data for a specific city
uv_index = client.get_uv_index(city={'lat': 51.51, 'lon': -0.13})

# Get weather alerts for a specific city
weather_alerts = client.get_weather_alerts(city='New York')

Replace your_api_key with your actual OpenWeatherMap API key.

Command Line Interface (CLI)

You can also use the command-line interface to retrieve weather data:

weather-cli --api-key <your_api_key> <city>

Note: Replace '' with your actual OpenWeatherMap API key and '' with the city for which you want to retrieve weather data.

The CLI supports the following commands:

Documentation

For detailed usage instructions and API documentation, please refer to the documentation.

Contributing

Contributions are welcome! If you have any suggestions, feature requests, or bug reports, please open an issue on GitHub. See the Code of conduct for more details.

License

This project is licensed under the MIT License. See the LICENSE file for details.