nwsapy

NWS-APy: A Pythonic Implementation of the National Weather Service API

NWS-APy (APy for short) takes a pythonic approach to retrieving (GET) and organizing data using the National Weather Service API (found here: https://www.weather.gov/documentation/services-web-api#/)

There are 3 goals that the package aims to achieve:

• Keep clean, simplistic, minimalistic, and consistent code on the user end.
• Minimize potential 404/500 errors and knowledge overhead.
• Format output to popular meteorological data types.

A simple example

APy is designed to be simple and easy to use. For example, if we wanted to get all of the tornado warnings in Oklahoma and just display the headline:

from nwsapy import api_connector

tor_warnings = api_connector.get_active_alerts(event = "Tornado Warning", area = "OK")

# Check to make sure there aren't any request errors.
# If so, let the user know by raising an error.
if tor_warnings.has_any_request_errors:
    raise ConnectionError(f'Details: {tor_warnings['detail']})

# iterate through all of the tornado warnings in Oklahoma and print the headline.
for warning in tor_warnings:
    print(warning.headline)

Documentation

Documentation for NWSAPy be found here

Contact/Support

I want to hear from you. If you have any questions regarding the package usage, please send me an email. If you encounter an issue, please open an issue on GitHub.