Merge pull request #1825 from chemsedd/weather-api-cli

Added OpenWeather CLI python script

Program's_Contributed_By_Contributors/openweather_cli.py

@@ -0,0 +1,107 @@
+"""
+    This is a command line tool for using the openweathermap.org API.
+    - Retrieving current weather of a specified city or cities,
+    - Easy way and no complicated libraries.
+    - Arguments for specifying the output.
+"""
+
+from os import environ
+import requests
+import argparse
+import time
+from datetime import datetime
+
+
+def init_args():
+    """Defines command line arguments.
+
+    Returns:
+        ArgumentParser: argument parser that contains the specified arguments.
+    """
+    helper = "Retrieves the current weather data from the api.openweathremap.org server of the given city."
+    parser = argparse.ArgumentParser(description=helper)
+
+    parser.add_argument(
+        "city", type=str, help="the name of the city to get weather for."
+    )
+    parser.add_argument(
+        "-v", "--verbose", action="store_true", help="displays more weather data"
+    )
+    parser.add_argument(
+        "-u",
+        "--units",
+        action="store",
+        help='for temperature in Fahrenheit use "imperial", for temperature in Celsius use "metric", temperature in Kelvin is used by default, no need to use units parameter in API call.',
+    )
+
+    return parser
+
+
+def get_weather_data(city, units):
+    """Retrieves the weather data of the given city name from 'api.openweathermap.org'.
+
+    Args:
+        city (string): CITY ID, or a list of cities names.
+        units (string): for temperature in Fahrenheit use "imperial", for temperature in Celsius use "metric", temperature in Kelvin is used by default, no need to use units parameter in API call.
+
+
+    Returns:
+        dict: A dictionary contains all data about the weather of the given city(ies)
+    """
+    API_KEY = environ["WEATHER_API_KEY"]
+    URL = f"http://api.openweathermap.org/data/2.5/weather?"
+    URL += f"q={city}&"
+    # use units argument if specified
+    if units != "":
+        URL += f"units={units}&"
+    URL += f"appid={API_KEY}"
+    data = requests.get(URL).json()
+
+    return data
+
+
+def print_weather_data(data, verbose):
+    """Displays the weather data in human readable format.
+
+    Args:
+        data (dict): dictionary that contains the weather data.
+        verbose (boolean): if `True`, more detail will be printed about the weather and the city.
+    """
+
+    info = f"""
+    ------------------------------
+    City        : {data['name']}
+    Country     : {data['sys']['country']}"""
+    if verbose:
+        info += f"""
+    Longitude   : {data['coord']['lon']}
+    Latitude    : {data['coord']['lat']}
+    Sunrise     : {datetime.fromtimestamp(data['sys']['sunrise']).time()}
+    Sunset      : {datetime.fromtimestamp(data['sys']['sunset']).time()}"""
+
+    info += f"""
+    ------------------------------
+    Temperature : {data['main']['temp']} ({data['main']['temp_min']}/{data['main']['temp_max']})
+    Pressure    : {data['main']['pressure']} 
+    Humidity    : {data['main']['humidity']} 
+    Wind speed  : {data['wind']['speed']}
+    Wind deg    : {data['wind']['deg']}
+    ------------------------------"""
+    if verbose:
+        info += f"""
+        """
+    return info
+
+
+if __name__ == "__main__":
+    # argument parser
+    parser = init_args()
+    # get cli arguments
+    args = parser.parse_args()
+
+    data = get_weather_data(city=args.city, units=args.units)
+    if data["cod"] != 200:
+        print(f"Error accured: {data['message']} ❌")
+        exit(0)
+    elif data["cod"] == 200:
+        print(print_weather_data(data, args.verbose))