Skip to main content

A Python wrapper around OpenWeatherMap web APIs

Project description

logo

PyOWM

A Python wrapper around OpenWeatherMap web APIs

PyPI version PyPI - Downloads
PyPI - Python Version
Latest Release Documentation Build Status Coverage Status
Buy Me A Coffee Say Thanks!

What is it?

PyOWM is a client Python wrapper library for OpenWeatherMap (OWM) web APIs. It allows quick and easy consumption of OWM data from Python applications via a simple object model and in a human-friendly fashion.

PyOWM runs on Python 3.9+

Former Dark Sky API users: you can can use PyOWM to get OpenWeatherMap's OneCall API data as an easy replacement to Dark Sky

What kind of data can I get with PyOWM ?

With PyOWM you can integrate into your code any of the following OpenWeatherMap web APIs:

  • Weather API v3.0 + OneCall API, providing current weather data, weather forecasts, weather history
  • Agro API v1.0, providing soil data and satellite imagery search and download
  • Air Pollution API v3.0, providing data about CO, O3, NO2 and SO2
  • UV Index API v3.0, providing data about Ultraviolet exposition
  • Stations API v3.0, allowing to create and manage meteostation and publish local weather measurements
  • Weather Alerts API v3.0, allowing to set triggers on weather conditions and areas and poll for spawned alerts
  • Image tiles for several map layers provided by OWM
  • Geocoding API v1.0 allowing to perform direct/reverse geocoding

In case of trouble...

Please read the FAQ before filing a new issue on GitHub! There are many common issues, therefore a fix for your issue might come easier than you think

Get started

API key

As OpenWeatherMap APIs need a valid API key to allow responses, PyOWM won't work if you don't provide one. This stands for both free and paid (pro) subscription plans. You can signup for a free API key on the OWM website Please notice that the free API subscription plan is subject to requests throttling.

Example

With a free OWM API Key:

from pyowm import OWM
from pyowm.utils import config
from pyowm.utils import timestamps

# ---------- FREE API KEY examples ---------------------

owm = OWM('your free OWM API key')
mgr = owm.weather_manager()


# Search for current weather in London (Great Britain) and get details
observation = mgr.weather_at_place('London,GB')
w = observation.weather

w.detailed_status         # 'clouds'
w.wind()                  # {'speed': 4.6, 'deg': 330}
w.humidity                # 87
w.temperature('celsius')  # {'temp_max': 10.5, 'temp': 9.7, 'temp_min': 9.0}
w.rain                    # {}
w.heat_index              # None
w.clouds                  # 75

# Will it be clear tomorrow at this time in Milan (Italy) ?
forecast = mgr.forecast_at_place('Milan,IT', 'daily')
answer = forecast.will_be_clear_at(timestamps.tomorrow())

# ---------- PAID API KEY example ---------------------

config_dict = config.get_default_config_for_subscription_type('professional')
owm = OWM('your paid OWM API key', config_dict)

# What's the current humidity in Berlin (Germany) ?
one_call_object = mgr.one_call(lat=52.5244, lon=13.4105)
one_call_object.current.humidity

Installation

Install with pip for your ease:

$ pip install pyowm

There are alternatives: setuptools, Windows installers and common Linux package managers such as Yaourt (Arch Linux) YaST/Zypper (OpenSuse) (please refer to the documentation for more detail)

Eager to fetch the very latest updates to PyOWM? Install the development trunk (which might be unstable). Eg on Linux:

$ git clone https://github.com/csparpa/pyowm.git
$ cd pyowm && git checkout develop
$ pip install -r requirements.txt && python setup.py install

Documentation

The library software API documentation is available on Read the Docs.

The Code recipes section comes in handy!

Community & Contributing

Here are some cool projects that use PyOWM

Contributors (coding, testing, packaging, reporting issues) are welcome! See the the official documentation website for details.

License

MIT license

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyowm-3.5.0.tar.gz (4.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyowm-3.5.0-py3-none-any.whl (4.5 MB view details)

Uploaded Python 3

File details

Details for the file pyowm-3.5.0.tar.gz.

File metadata

  • Download URL: pyowm-3.5.0.tar.gz
  • Upload date:
  • Size: 4.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pyowm-3.5.0.tar.gz
Algorithm Hash digest
SHA256 9a44d6d43941419a73fd9dbe16066ad8a25204ea906774fd5bf5b0ec52d2a1a4
MD5 bfeb2e176a705043b34cbf0146cb63c4
BLAKE2b-256 3fbc4afbc60995ba757b0f6c4d200daa4b544a5100154ffcf169b848d5ef0392

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyowm-3.5.0.tar.gz:

Publisher: publish.yml on csparpa/pyowm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyowm-3.5.0-py3-none-any.whl.

File metadata

  • Download URL: pyowm-3.5.0-py3-none-any.whl
  • Upload date:
  • Size: 4.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pyowm-3.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6f71bdec738af809b7a43c0725094756f04dbf78bf48eb0f72efbfc6f11ddd8f
MD5 a6c754f5b29222262a490dee6982e06e
BLAKE2b-256 7241f1cf7e715a90dd3ba3d1c5a20ba3703529a41a27ce6fd5a6700acc78a8fe

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyowm-3.5.0-py3-none-any.whl:

Publisher: publish.yml on csparpa/pyowm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page