A Python wrapper around the OpenWeatherMap web API
Clone or download
Latest commit 197540d Jul 30, 2018

README.md

logo

PyOWM

A Python wrapper around the OpenWeatherMap API

PyPI version Latest Release Documentation Build Status Coverage Status 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 2.7 and Python 3.4+ (but watch out! Python 2.x will eventually be dropped - check details out)

PyOWM also integrates with Django 1.10+ models.

Installation

Install with pip for your ease:

$ pip install pyowm

There is a lot of alternatives: setuptools, Windows installers and common package managers such as Yaourt

Eager to fetch the very latest updates to PyOWM? Install the development trunk:

$ pip install git+https://github.com/csparpa/pyowm.git@develop

Usage

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.

Examples

That's a simple example of what you can do with PyOWM and a free OWM API Key:

import pyowm

owm = pyowm.OWM('your-API-key')  # You MUST provide a valid API key

# Have a pro subscription? Then use:
# owm = pyowm.OWM(API_key='your-API-key', subscription_type='pro')

# Search for current weather in London (Great Britain)
observation = owm.weather_at_place('London,GB')
w = observation.get_weather()
print(w)                      # <Weather - reference time=2013-12-18 09:20,
                              # status=Clouds>

# Weather details
w.get_wind()                  # {'speed': 4.6, 'deg': 330}
w.get_humidity()              # 87
w.get_temperature('celsius')  # {'temp_max': 10.5, 'temp': 9.7, 'temp_min': 9.0}

# Search current weather observations in the surroundings of
# lat=22.57W, lon=43.12S (Rio de Janeiro, BR)
observation_list = owm.weather_around_coords(-22.57, -43.12)

And this is a usage example with a paid OWM API key:

import pyowm

paid_owm = pyowm.OWM(API_key='your-pro-API-key', subscription_type='pro')

# Will it be clear tomorrow at this time in Milan (Italy) ?
forecast = paid_owm.daily_forecast("Milan,IT")
tomorrow = pyowm.timeutils.tomorrow()
forecast.will_be_clear_at(tomorrow)  # The sun always shines on Italy, right? ;-)

More PyOWM usage examples are available here.

Documentation

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

Each release has its own changelog.

Contributing

Contributors (coding, testing, packaging, reporting issues) are welcome!.

See the the official documentation website for details or the CONTRIBUTING.md file for a quick primer.

Community

Join the PyOWM public Slack team by signing up here

Here are some cool projects that use PyOWM

References

License

MIT license