Add weather fetching and display script

how-to-use-github/fixed_code/weather.py

@@ -0,0 +1,190 @@
+import argparse
+import json
+import sys
+from configparser import ConfigParser
+from urllib import error, parse, request
+from pathlib import Path
+
+# =========================
+# Styling / Colors
+# =========================
+
+PADDING = 20
+
+RED = "\033[1;31m"
+BLUE = "\033[1;34m"
+CYAN = "\033[1;36m"
+GREEN = "\033[0;32m"
+YELLOW = "\033[33m"
+WHITE = "\033[37m"
+
+REVERSE = "\033[;7m"
+RESET = "\033[0m"
+
+
+def change_color(color):
+    print(color, end="")
+
+# =========================
+# Weather Config
+# =========================
+
+BASE_WEATHER_API_URL = "http://api.openweathermap.org/data/2.5/weather"
+
+# Weather Condition Codes
+# https://openweathermap.org/weather-conditions#Weather-Condition-Codes-2
+THUNDERSTORM = range(200, 300)
+DRIZZLE = range(300, 400)
+RAIN = range(500, 600)
+SNOW = range(600, 700)
+ATMOSPHERE = range(700, 800)
+CLEAR = range(800, 801)
+CLOUDY = range(801, 900)
+
+
+def read_user_cli_args():
+    """Handles the CLI user interactions.
+
+    Returns:
+        argparse.Namespace: Populated namespace object
+    """
+    parser = argparse.ArgumentParser(
+        description="gets weather and temperature information for a city"
+    )
+    parser.add_argument(
+        "city", nargs="+", type=str, help="enter the city name"
+    )
+    parser.add_argument(
+        "-i",
+        "--imperial",
+        action="store_true",
+        help="display the temperature in imperial units",
+    )
+    return parser.parse_args()
+
+
+def build_weather_query(city_input, imperial=False):
+    """Builds the URL for an API request to OpenWeather's Weather API.
+
+    Args:
+        city_input (List[str]): Name of a city as collected by argparse
+        imperial (bool): Whether or not to use imperial units for temperature
+
+    Returns:
+        str: URL formatted for a call to OpenWeather's city name endpoint
+    """
+    api_key = _get_api_key()
+    city_name = " ".join(city_input)
+    url_encoded_city_name = parse.quote_plus(city_name)
+    units = "imperial" if imperial else "metric"
+    url = (
+        f"{BASE_WEATHER_API_URL}?q={url_encoded_city_name}"
+        f"&units={units}&appid={api_key}"
+    )
+    return url
+
+
+def _get_api_key():
+    """Fetch the API key from your configuration file.
+
+    Expects a configuration file named "secrets.ini" with structure:
+
+        [openweather]
+        api_key=<YOUR-OPENWEATHER-API-KEY>
+    """
+    config = ConfigParser()
+    config.read(Path(__file__).parent / "secrets.ini")
+    return config["openweather"]["api_key"]
+
+
+def get_weather_data(query_url):
+    """Makes an API request to a URL and returns the data as a Python object.
+
+    Args:
+        query_url (str): URL formatted for OpenWeather's city name endpoint
+
+    Returns:
+        dict: Weather information for a specific city
+    """
+    try:
+        response = request.urlopen(query_url)
+    except error.HTTPError as http_error:
+        if http_error.code == 401:  # 401 - Unauthorized
+            sys.exit("Access denied. Check your API key.")
+        elif http_error.code == 404:  # 404 - Not Found
+            sys.exit("Can't find weather data for this city.")
+        else:
+            sys.exit(f"Something went wrong... ({http_error.code})")
+
+    data = response.read()
+
+    try:
+        return json.loads(data)
+    except json.JSONDecodeError:
+        sys.exit("Couldn't read the server response.")
+
+
+def display_weather_info(weather_data, imperial=False):
+    """Prints formatted weather information about a city.
+
+    Args:
+        weather_data (dict): API response from OpenWeather by city name
+        imperial (bool): Whether or not to use imperial units for temperature
+
+    More information at https://openweathermap.org/current#name
+    """
+    city = weather_data["name"]
+    weather_id = weather_data["weather"][0]["id"]
+    weather_description = weather_data["weather"][0]["description"]
+    temperature = weather_data["main"]["temp"]
+
+    change_color(REVERSE)
+    print(f"{city:^{PADDING}}", end="")
+    change_color(RESET)
+
+    weather_symbol, color = _select_weather_display_params(weather_id)
+    change_color(color)
+
+    print(f"\t{weather_symbol}", end=" ")
+    print(
+        f"\t{weather_description.capitalize():^{PADDING}}",
+        end=" ",
+    )
+    change_color(RESET)
+
+    print(f"({temperature}°{'F' if imperial else 'C'})")
+
+
+def _select_weather_display_params(weather_id):
+    """Selects a weather symbol and a display color for a weather state.
+
+    Args:
+        weather_id (int): Weather condition code from the OpenWeather API
+
+    Returns:
+        tuple[str]: Contains a weather symbol and a display color
+    """
+    if weather_id in THUNDERSTORM:
+        display_params = ("💥", RED)
+    elif weather_id in DRIZZLE:
+        display_params = ("💧", CYAN)
+    elif weather_id in RAIN:
+        display_params = ("💦", BLUE)
+    elif weather_id in SNOW:
+        display_params = ("⛄️", WHITE)
+    elif weather_id in ATMOSPHERE:
+        display_params = ("🌀", BLUE)
+    elif weather_id in CLEAR:
+        display_params = ("🔆", YELLOW)
+    elif weather_id in CLOUDY:
+        display_params = ("💨", WHITE)
+    else:  # In case the API adds new weather codes
+        display_params = ("🌈", RESET)
+    return display_params
+
+
+if __name__ == "__main__":
+    user_args = read_user_cli_args()
+    query_url = build_weather_query(user_args.city, user_args.imperial)
+    weather_data = get_weather_data(query_url)
+    display_weather_info(weather_data, user_args.imperial)

how-to-use-github/initial_code/weather.py

@@ -0,0 +1,189 @@
+import argparse
+import json
+import sys
+from configparser import ConfigParser
+from urllib import error, parse, request
+
+# =========================
+# Styling / Colors
+# =========================
+
+PADDING = 20
+
+RED = "\033[1;31m"
+BLUE = "\033[1;34m"
+CYAN = "\033[1;36m"
+GREEN = "\033[0;32m"
+YELLOW = "\033[33m"
+WHITE = "\033[37m"
+
+REVERSE = "\033[;7m"
+RESET = "\033[0m"
+
+
+def change_color(color):
+    print(color, end="")
+
+# =========================
+# Weather Config
+# =========================
+
+BASE_WEATHER_API_URL = "http://api.openweathermap.org/data/2.5/weather"
+
+# Weather Condition Codes
+# https://openweathermap.org/weather-conditions#Weather-Condition-Codes-2
+THUNDERSTORM = range(200, 300)
+DRIZZLE = range(300, 400)
+RAIN = range(500, 600)
+SNOW = range(600, 700)
+ATMOSPHERE = range(700, 800)
+CLEAR = range(800, 801)
+CLOUDY = range(801, 900)
+
+
+def read_user_cli_args():
+    """Handles the CLI user interactions.
+
+    Returns:
+        argparse.Namespace: Populated namespace object
+    """
+    parser = argparse.ArgumentParser(
+        description="gets weather and temperature information for a city"
+    )
+    parser.add_argument(
+        "city", nargs="+", type=str, help="enter the city name"
+    )
+    parser.add_argument(
+        "-i",
+        "--imperial",
+        action="store_true",
+        help="display the temperature in imperial units",
+    )
+    return parser.parse_args()
+
+
+def build_weather_query(city_input, imperial=False):
+    """Builds the URL for an API request to OpenWeather's Weather API.
+
+    Args:
+        city_input (List[str]): Name of a city as collected by argparse
+        imperial (bool): Whether or not to use imperial units for temperature
+
+    Returns:
+        str: URL formatted for a call to OpenWeather's city name endpoint
+    """
+    api_key = _get_api_key()
+    city_name = " ".join(city_input)
+    url_encoded_city_name = parse.quote_plus(city_name)
+    units = "imperial" if imperial else "metric"
+    url = (
+        f"{BASE_WEATHER_API_URL}?q={url_encoded_city_name}"
+        f"&units={units}&appid={api_key}"
+    )
+    return url
+
+
+def _get_api_key():
+    """Fetch the API key from your configuration file.
+
+    Expects a configuration file named "secrets.ini" with structure:
+
+        [openweather]
+        api_key=<YOUR-OPENWEATHER-API-KEY>
+    """
+    config = ConfigParser()
+    config.read("secrets.ini")
+    return config["openweather"]["api_key"]
+
+
+def get_weather_data(query_url):
+    """Makes an API request to a URL and returns the data as a Python object.
+
+    Args:
+        query_url (str): URL formatted for OpenWeather's city name endpoint
+
+    Returns:
+        dict: Weather information for a specific city
+    """
+    try:
+        response = request.urlopen(query_url)
+    except error.HTTPError as http_error:
+        if http_error.code == 401:  # 401 - Unauthorized
+            sys.exit("Access denied. Check your API key.")
+        elif http_error.code == 404:  # 404 - Not Found
+            sys.exit("Can't find weather data for this city.")
+        else:
+            sys.exit(f"Something went wrong... ({http_error.code})")
+
+    data = response.read()
+
+    try:
+        return json.loads(data)
+    except json.JSONDecodeError:
+        sys.exit("Couldn't read the server response.")
+
+
+def display_weather_info(weather_data, imperial=False):
+    """Prints formatted weather information about a city.
+
+    Args:
+        weather_data (dict): API response from OpenWeather by city name
+        imperial (bool): Whether or not to use imperial units for temperature
+
+    More information at https://openweathermap.org/current#name
+    """
+    city = weather_data["name"]
+    weather_id = weather_data["weather"][0]["id"]
+    weather_description = weather_data["weather"][0]["description"]
+    temperature = weather_data["main"]["temp"]
+
+    change_color(REVERSE)
+    print(f"{city:^{PADDING}}", end="")
+    change_color(RESET)
+
+    weather_symbol, color = _select_weather_display_params(weather_id)
+    change_color(color)
+
+    print(f"\t{weather_symbol}", end=" ")
+    print(
+        f"\t{weather_description.capitalize():^{PADDING}}",
+        end=" ",
+    )
+    change_color(RESET)
+
+    print(f"({temperature}°{'F' if imperial else 'C'})")
+
+
+def _select_weather_display_params(weather_id):
+    """Selects a weather symbol and a display color for a weather state.
+
+    Args:
+        weather_id (int): Weather condition code from the OpenWeather API
+
+    Returns:
+        tuple[str]: Contains a weather symbol and a display color
+    """
+    if weather_id in THUNDERSTORM:
+        display_params = ("💥", RED)
+    elif weather_id in DRIZZLE:
+        display_params = ("💧", CYAN)
+    elif weather_id in RAIN:
+        display_params = ("💦", BLUE)
+    elif weather_id in SNOW:
+        display_params = ("⛄️", WHITE)
+    elif weather_id in ATMOSPHERE:
+        display_params = ("🌀", BLUE)
+    elif weather_id in CLEAR:
+        display_params = ("🔆", YELLOW)
+    elif weather_id in CLOUDY:
+        display_params = ("💨", WHITE)
+    else:  # In case the API adds new weather codes
+        display_params = ("🌈", RESET)
+    return display_params
+
+
+if __name__ == "__main__":
+    user_args = read_user_cli_args()
+    query_url = build_weather_query(user_args.city, user_args.imperial)
+    weather_data = get_weather_data(query_url)
+    display_weather_info(weather_data, user_args.imperial)