Skip to main content

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

  • Provides a Python interface to interact with the OpenWeatherMap API.
  • Retrieve current weather, weather forecast, historical weather data, air pollution data, UV index data, and weather alerts for a specified location.
  • Command-line interface (CLI) for easy access to weather data.

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 London

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

The CLI supports the following commands:

  • weather-cli: Fetches current weather data for a specified city.
  • weather-cli --api-key your_api_key --forecast London: Fetches weather forecast data for a specified city.
  • weather-cli --api-key your_api_key --historical London --start-date 2024-04-01 --end-date 2024-04-07: Fetches historical weather data for a specified city and date range.
  • weather-cli --api-key your_api_key --pollution London: Fetches air pollution data for a specified city.
  • weather-cli --api-key your_api_key --uv London: Fetches UV index data for a specified city.
  • weather-cli --api-key your_api_key --alerts London: Fetches weather alerts for a specified city.

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.

Metadata

Release files for weather-api-wrapper 0.1.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for weather-api-wrapper 0.1.6
File Size Uploaded
weather_api_wrapper-0.1.6.tar.gz 6.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for weather-api-wrapper 0.1.6
File Interpreter ABI Platform
weather_api_wrapper-0.1.6-py3-none-any.whl Python 3 none any Details

Total release size: 13.9 kB

Release files / weather_api_wrapper-0.1.6.tar.gz

Download URL weather_api_wrapper-0.1.6.tar.gz
Size 6.6 kB
Tags Source
SHA-256 checksum
How to use checksums
000ce33bc49f1265a5d48a7afc6bd3a12fd96d04756166ad011c15f6267f80fa
BLAKE2b-256 checksum
How to use checksums
ce2ec7a7fc5829acf78cd0ed6013350e2a67397878de8d7f55ec8aa0acbc60f4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.2

Release files / weather_api_wrapper-0.1.6-py3-none-any.whl

Download URL weather_api_wrapper-0.1.6-py3-none-any.whl
Size 7.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
79e43156d0f766917c02324e0779973f03c8284073922655ae88febd81eff88d
BLAKE2b-256 checksum
How to use checksums
082dfd7f4ef4d27549958bff39f1e649b1948e48acfefaf636894eb6bd0f5140
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.2

Release history Release notifications | RSS feed

This release

0.1.6 This release

2 release files

0.1.5

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page