robotframework-openweathermap

robotframework-openweathermap is a Robot Framework keyword collection for the OpenWeatherMap API.

Installation

The easiest way is to install this package is from pypi:

pip install robotframework-openweathermap

Robot Framework Library Examples

Prerequisites:

The accompanying Robot Framework test file relies on two requirements:

• get an OpenWeatherMap API key (it's free)
• create an environment variable OWM_API_KEY and assign the OpenWeatherMap API key to that variable
• Execute test with robot keyword_checks.robot

Library usage and supported keywords

Default settings

The following rules apply:

• The default value for each parameter is None
• Each parameter supports Getter and Setter keywords, e.g, Set OpenWeatherMap Latitude
• Each OpenWeatherMap Keyword also permits the usage of these parameters. Example:

Get Current Weather   latitude=....

• A keyword's parameter value has priority over the Setter value. This means that if you use Set OpenWeathermap Latitude 10 and Get Current Weather latitude=20, the value from the OWK Keyword will supersede the Setter keyword and a value of 20 is going to be used.

Options for setting the parameter values

You can either specify all parameters during the initial setup of the library or alternatively via separate keywords

Option 1 - set as position parameters

*** Settings ***

Library  OpenWeatherMapLibrary  51.82798  9.4455  ...

*** Test Cases ***
My first test case

Option 2 - set as named parameters

*** Settings ***

Library  OpenWeatherMapLibrary  latitude=51.82798  longitude=9.4455  ...

*** Test Cases ***
My first test case

Option 3 - Use Robot Keywords

Set OpenWeatherMap Latitude   latitude=51.82798

Generic Getter / Setter Robot Keywords supported by this library

You can use these optional Getter/Setter methods for setting your fixed default values. If you specify the same parameter as part of the actual OpenWeatherMap keyword, the value specified with that API call supersedes these generic Getter/Setter values.

OpenWeatherMap Keywords

Please note that a majority of these keywords requires a paid OpenWeatherMap subscription. You can still try to run the keywords but most of them will fail with a http 4xx error unless you have a valid paid subscription.

Each of the following keywords has a set of mandatory parameters. which means that if you used the setter methods to assign values for latitude and longitude, for example, you can omit those values for the following keywords.

Known issues

• Not all OpenWeatherMap APIs have been assigned with corresponding Robot Framework keywords. What you see is what you get - at least for this version.
• The Get Road Risk Data keyword only supports a single set of latitude and longitude values (the underlying API supports multiple sets)