v0.7505 - integrate NWS API and handle weather alerts

FlyingFathead · FlyingFathead · commit e186d8480d02 · 2024-10-07T20:23:20.000+03:00
diff --git a/README.md b/README.md
@@ -236,6 +236,9 @@ If you run into any issues, consult the logs or reach out on the repository's [I
 ---
 
 # Changelog
+- v0.7505 - U.S. NWS (National Weather Service, [weather.gov](https://weather.gov)) added as a weather data source
+  - for additional information; **especially weather alerts**
+  - all data will be combined from OpenWeatherMap and U.S. NWS sources by default
 - v0.7504 - fixed usage logs and charts directory mapping
 - v0.7503 - improved message formatting & error catching
 - v0.7502 - added `docker_setup.sh` for easier Docker-based deployment
diff --git a/src/api_get_nws_weather.py b/src/api_get_nws_weather.py
@@ -0,0 +1,113 @@
+# api_get_nws.py
+#
+# > get the weather using the NWS (National Weather Service, US) API
+#
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# github.com/FlyingFathead/TelegramBot-OpenAI-API/
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+import asyncio
+import httpx
+import logging
+
+# Base URL for NWS API
+NWS_BASE_URL = 'https://api.weather.gov'
+
+# Custom User-Agent as per NWS API requirements
+USER_AGENT = 'ChatKekeWeather/1.0 (flyingfathead@protonmail.com)'
+
+# Default number of retries if not specified
+RETRIES = 0
+
+async def get_nws_forecast(lat, lon, retries=RETRIES, delay=2):
+    """
+    Fetches the forecast from the NWS API for the given latitude and longitude.
+    
+    Args:
+        lat (float): Latitude in decimal degrees.
+        lon (float): Longitude in decimal degrees.
+        retries (int): Number of retries for transient errors. Defaults to RETRIES.
+        delay (int): Delay between retries in seconds.
+    
+    Returns:
+        dict: Combined forecast data or None if fetching fails.
+    """
+    # Round coordinates to 4 decimal places
+    lat = round(lat, 4)
+    lon = round(lon, 4)
+    points_url = f"{NWS_BASE_URL}/points/{lat},{lon}"
+    
+    async with httpx.AsyncClient(follow_redirects=True) as client:
+        for attempt in range(retries + 1):  # Ensure at least one attempt is made
+            try:
+                # Step 1: Retrieve metadata for the location
+                response = await client.get(points_url, headers={'User-Agent': USER_AGENT})
+                response.raise_for_status()
+                points_data = response.json()
+                
+                # Extract forecast URLs
+                forecast_url = points_data['properties']['forecast']
+                forecast_hourly_url = points_data['properties'].get('forecastHourly')
+                
+                # Step 2: Retrieve forecast data
+                forecast_response = await client.get(forecast_url, headers={'User-Agent': USER_AGENT})
+                forecast_response.raise_for_status()
+                forecast_data = forecast_response.json()
+                
+                # Step 3: Retrieve hourly forecast data
+                forecast_hourly_data = None
+                if forecast_hourly_url:
+                    try:
+                        forecast_hourly_response = await client.get(forecast_hourly_url, headers={'User-Agent': USER_AGENT})
+                        forecast_hourly_response.raise_for_status()
+                        forecast_hourly_data = forecast_hourly_response.json()
+                    except httpx.HTTPStatusError as e:
+                        logging.error(f"NWS Hourly Forecast HTTP error: {e.response.status_code} - {e.response.text}")
+                
+                return {
+                    'nws_forecast': forecast_data,
+                    'nws_forecast_hourly': forecast_hourly_data
+                }
+            
+            except httpx.HTTPStatusError as e:
+                if e.response.status_code >= 500 and attempt < retries:
+                    logging.warning(f"NWS API HTTP error: {e.response.status_code} - {e.response.text}. Retrying in {delay} seconds...")
+                    await asyncio.sleep(delay)
+                else:
+                    logging.error(f"NWS API HTTP error: {e.response.status_code} - {e.response.text}")
+                    break
+            except Exception as e:
+                logging.error(f"Error fetching NWS forecast: {e}")
+                break
+        
+    return None
+
+async def get_nws_alerts(lat, lon):
+    """
+    Fetches active alerts from the NWS API for the given latitude and longitude.
+    
+    Args:
+        lat (float): Latitude in decimal degrees.
+        lon (float): Longitude in decimal degrees.
+    
+    Returns:
+        list: A list of active alerts or an empty list if none are found.
+    """
+    alerts_url = f"{NWS_BASE_URL}/alerts/active?point={lat},{lon}"
+    
+    async with httpx.AsyncClient() as client:
+        try:
+            response = await client.get(alerts_url, headers={'User-Agent': USER_AGENT})
+            response.raise_for_status()
+            alerts_data = response.json()
+            
+            # Extract alerts from GeoJSON
+            alerts = alerts_data.get('features', [])
+            return alerts
+        
+        except httpx.HTTPStatusError as e:
+            logging.error(f"NWS Alerts API HTTP error: {e.response.status_code} - {e.response.text}")
+        except Exception as e:
+            logging.error(f"Error fetching NWS alerts: {e}")
+    
+    return []
diff --git a/src/api_get_openweathermap.py b/src/api_get_openweathermap.py
@@ -12,6 +12,9 @@
 # export OPENWEATHERMAP_API_KEY="<your API key>"
 # export MAPTILER_API_KEY="<your API key>"
 
+# Import the NWS data fetching function
+from api_get_nws_weather import get_nws_forecast, get_nws_alerts
+
 # date & time utils
 import datetime as dt
 from dateutil import parser
@@ -74,8 +77,38 @@ async def get_weather(city_name, country, exclude='', units='metric', lang='fi')
                 additional_data = await get_additional_data_dump()
                 logging.info(f"Additional data fetched: {additional_data}")
 
-            combined_data = await combine_weather_data(city_name, resolved_country, lat, lon, current_weather_data, forecast_data, moon_phase_data, daily_forecast_data, current_weather_data_from_weatherapi, astronomy_data, additional_data)
-            return combined_data
+            # // (old method)
+            # combined_data = await combine_weather_data(city_name, resolved_country, lat, lon, current_weather_data, forecast_data, moon_phase_data, daily_forecast_data, current_weather_data_from_weatherapi, astronomy_data, additional_data)
+            # return combined_data
+
+            # Fetch NWS data
+            logging.info("Fetching NWS data.")
+            nws_data = await get_nws_forecast(lat, lon)
+            if nws_data:
+                logging.info("NWS data fetched successfully.")
+                nws_forecast = nws_data.get('nws_forecast')
+                nws_forecast_hourly = nws_data.get('nws_forecast_hourly')
+            else:
+                logging.warning("Failed to fetch NWS data.")
+                nws_forecast = None
+                nws_forecast_hourly = None
+
+            # Fetch NWS alerts data
+            logging.info("Fetching NWS alerts data.")
+            nws_alerts = await get_nws_alerts(lat, lon)
+            if nws_alerts:
+                logging.info(f"Fetched {len(nws_alerts)} active NWS alerts.")
+            else:
+                logging.info("No active NWS alerts found.")
+
+            combined_data = await combine_weather_data(
+                city_name, resolved_country, lat, lon,
+                current_weather_data, forecast_data, moon_phase_data,
+                daily_forecast_data, current_weather_data_from_weatherapi,
+                astronomy_data, additional_data, nws_forecast, nws_forecast_hourly
+            )
+            return combined_data        
+
         else:
             logging.error(f"Failed to fetch weather data: {current_weather_response.text} / {forecast_response.text}")
             return "[Inform the user that data fetching the weather data failed, current information could not be fetched. Reply in the user's language.]"
@@ -172,7 +205,9 @@ def convert_to_24_hour(time_str, timezone_str):
         return "Invalid time"
 
 # combined weather data
-async def combine_weather_data(city_name, country, lat, lon, current_weather_data, forecast_data, moon_phase_data, daily_forecast_data, current_weather_data_from_weatherapi, astronomy_data, additional_data):
+# async def combine_weather_data(city_name, country, lat, lon, current_weather_data, forecast_data, moon_phase_data, daily_forecast_data, current_weather_data_from_weatherapi, astronomy_data, additional_data):
+# Define the combine_weather_data function with NWS integration
+async def combine_weather_data(city_name, country, lat, lon, current_weather_data, forecast_data, moon_phase_data, daily_forecast_data, current_weather_data_from_weatherapi, astronomy_data, additional_data, nws_forecast, nws_forecast_hourly):
     tf = TimezoneFinder()
     timezone_str = tf.timezone_at(lat=lat, lng=lon)
     local_timezone = pytz.timezone(timezone_str)
@@ -285,7 +320,7 @@ async def combine_weather_data(city_name, country, lat, lon, current_weather_dat
             "\n".join(
                 [f"Alert: {alert['headline']}\nDescription: {alert['desc']}\nInstructions: {alert['instruction']}\n"
                  for alert in alerts['alert']]
-            ) if 'alert' in alerts and alerts['alert'] else "No weather alerts."
+            ) if 'alert' in alerts and alerts['alert'] else "No weather alerts according to OpenWeatherMap. NOTE: Please see other sources (i.e. NWS) to be sure."
         )
 
         detailed_weather_info += f"\n{air_quality_info}\n{alerts_info}"
@@ -324,6 +359,113 @@ async def combine_weather_data(city_name, country, lat, lon, current_weather_dat
 
     combined_info = f"{detailed_weather_info}\n\n{final_forecast}"
 
+
+    # Append NWS data (Forecasts)
+    if nws_forecast:
+        nws_forecast_info = ""
+        nws_periods = nws_forecast.get('properties', {}).get('periods', [])
+        if nws_periods:
+            nws_forecast_info += "🌦️ <b>NWS Forecast (weather.gov):</b>\n"
+            for period in nws_periods[:3]:  # Limit to next 3 periods
+                name = period.get('name', 'N/A')
+                temperature = period.get('temperature', 'N/A')
+                temperature_unit = period.get('temperatureUnit', 'N/A')
+                wind_speed = period.get('windSpeed', 'N/A')
+                wind_direction = period.get('windDirection', 'N/A')
+                short_forecast = period.get('shortForecast', 'N/A')
+                nws_forecast_info += f"{name}: {short_forecast}, {temperature}°{temperature_unit}, Wind: {wind_speed} {wind_direction}\n"
+        else:
+            nws_forecast_info += "🌦️ <b>NWS Forecast (weather.gov):</b> Ei saatavilla.\n"
+
+        if nws_forecast_hourly:
+            nws_hourly_forecast_info = ""
+            nws_hourly_periods = nws_forecast_hourly.get('properties', {}).get('periods', [])
+            if nws_hourly_periods:
+                nws_hourly_forecast_info += "⏰ <b>NWS Hourly Forecast:</b>\n"
+                for period in nws_hourly_periods[:3]:  # Limit to next 3 hourly forecasts
+                    start_time = period.get('startTime', 'N/A')
+                    temperature = period.get('temperature', 'N/A')
+                    temperature_unit = period.get('temperatureUnit', 'N/A')
+                    wind_speed = period.get('windSpeed', 'N/A')
+                    wind_direction = period.get('windDirection', 'N/A')
+                    short_forecast = period.get('shortForecast', 'N/A')
+                    nws_hourly_forecast_info += f"{start_time}: {short_forecast}, {temperature}°{temperature_unit}, Wind: {wind_speed} {wind_direction}\n"
+            else:
+                nws_hourly_forecast_info += "⏰ <b>NWS Hourly Forecast:</b> Ei saatavilla.\n"
+        else:
+            nws_hourly_forecast_info = "⏰ <b>NWS Hourly Forecast:</b> Ei saatavilla.\n"
+
+        combined_info += f"\n{nws_forecast_info}\n{nws_hourly_forecast_info}"
+
+    # Fetch and append NWS Alerts
+    try:
+        # Round coordinates to 4 decimal places to comply with NWS API
+        lat_rounded = round(lat, 4)
+        lon_rounded = round(lon, 4)
+        alerts_url = f"https://api.weather.gov/alerts/active?point={lat_rounded},{lon_rounded}"
+        async with httpx.AsyncClient(follow_redirects=True) as client:
+            alerts_response = await client.get(alerts_url, headers={'User-Agent': 'YourAppName (youremail@example.com)'})
+            alerts_response.raise_for_status()
+            alerts_data = alerts_response.json()
+    except httpx.HTTPStatusError as e:
+        logging.error(f"NWS Alerts HTTP error: {e.response.status_code} - {e.response.text}")
+        alerts_data = None
+    except Exception as e:
+        logging.error(f"Error fetching NWS alerts: {e}")
+        alerts_data = None
+
+    alerts_info = ""
+    if alerts_data and 'features' in alerts_data and alerts_data['features']:
+        alerts_info += "[HUOM! HUOMIOI NÄMÄ! TAKE THESE INTO ACCOUNT!!! MENTION THESE TO THE USER IF THERE ARE WEATHER ALERTS -- INCLUDE ALL THE DETAILS. WHAT, WHEN, WHERE, WHAT SEVERITY, ETC.]\n🚨 <b>ONGOING ALERTS FROM THE U.S. NWS (weather.gov):</b>\n"
+        for idx, alert in enumerate(alerts_data['features'], start=1):
+            properties = alert.get('properties', {})
+            
+            event = properties.get('event', 'EVENT').upper()
+            headline = properties.get('headline', 'HEADLINE')
+            instruction = properties.get('instruction', 'INSTRUCTION')
+            severity = properties.get('severity', 'Unknown').capitalize()
+            certainty = properties.get('certainty', 'Unknown').capitalize()
+            urgency = properties.get('urgency', 'Unknown').capitalize()
+            area_desc = properties.get('areaDesc', 'N/A')
+            effective = properties.get('effective', 'N/A')
+            expires = properties.get('expires', 'N/A')
+            
+            alerts_info += (
+                f"{idx}. ⚠️ <b>{event}</b>\n"
+                f"<b>Vaara:</b> {headline}\n"
+                f"<b>Ohjeet:</b> {instruction}\n"
+                f"<b>Alue:</b> {area_desc}\n"
+                f"<b>Vakavuus:</b> {severity}\n"
+                f"<b>Varmuus:</b> {certainty}\n"
+                f"<b>Kiireellisyys:</b> {urgency}\n"
+                f"<b>Voimassa alkaen:</b> {effective}\n"
+                f"<b>Päättyy:</b> {expires}\n\n"
+            )
+    else:
+        alerts_info += "\n🚨 Ei aktiivisia varoituksia U.S. NWS:n (weather.gov) mukaan.\n"
+
+    # if alerts_data and 'features' in alerts_data and alerts_data['features']:
+    #     alerts_info += "\n🚨 <b>NWS ALERTS:</b>\n"
+    #     for alert in alerts_data['features']:
+    #         event = alert.get('properties', {}).get('event', 'EVENT').upper()
+    #         severity = alert.get('properties', {}).get('severity', 'SEVERITY').upper()
+    #         headline = alert.get('properties', {}).get('headline', 'HEADLINE')
+    #         instruction = alert.get('properties', {}).get('instruction', 'INSTRUCTION')
+
+    #         # Highlight severe alerts
+    #         if 'HURRICANE' in event or severity in ['WATCH', 'WARNING', 'EMERGENCY']:
+    #             alerts_info += f"🔥 <b>{event}</b>\n<b>Vaara:</b> {headline}\n<b>Ohjeet:</b> {instruction}\n\n"
+    #         else:
+    #             # Include less severe alerts if needed
+    #             alerts_info += f"<b>{event}</b>\n{headline}\n{instruction}\n\n"
+    # else:
+    #     alerts_info += "\n🚨 <b>NWS ALERTS:</b> Ei aktiivisia varoituksia.\n"
+
+    combined_info += alerts_info
+
+    # Combine all information
+    combined_info += f"\n{detailed_weather_info}\n\n{final_forecast}"
+
     # Append additional data for Finland if available
     if additional_data:
         combined_info += f"\n\n[ Lisätiedot Suomeen (lähde: foreca.fi -- MAINITSE LÄHDE) ]\n{additional_data}"
diff --git a/src/main.py b/src/main.py
@@ -5,7 +5,7 @@
 # https://github.com/FlyingFathead/TelegramBot-OpenAI-API
 #
 # version of this program
-version_number = "0.7504"
+version_number = "0.7505"
 
 # Add the project root directory to Python's path
 import sys

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`# https://github.com/FlyingFathead/TelegramBot-OpenAI-API`
`6`	`6`	`#`
`7`	`7`	`# version of this program`
`8`		`-version_number = "0.7504"`
	`8`	`+version_number = "0.7505"`
`9`	`9`
`10`	`10`	`# Add the project root directory to Python's path`
`11`	`11`	`import sys`