Merge pull request #715 from LightxAman/LightxAman

Hello, this is my attempt to enhance the previous code for project "API based weather report"

Author: Mrinank-Bhowmick

projects/API Based Weather Report/API Based Weather Report.py

@@ -1,42 +1,94 @@
 import requests
-import os
 from datetime import datetime
 
-api_key = "Enter your api key here"
-location = input("\nEnter the city name   : ")
-
-complete_api_link = (
-    "https://api.openweathermap.org/data/2.5/weather?q="
-    + location
-    + "&appid="
-    + api_key
-)
-api_link = requests.get(complete_api_link)
-api_data = api_link.json()
-
-# create variables to store and display data
-
-try:
-    temp_city = (api_data["main"]["temp"]) - 273.15
-    weather_desc = api_data["weather"][0]["description"]
-    hmdt = api_data["main"]["humidity"]
-    wind_spd = api_data["wind"]["speed"]
-    date_time = datetime.now().strftime("%d %b %Y | %I:%M:%S %p")
-
-    f = open("wetherinfo.txt", "w+")
-    f.write("-------------------------------------------------------------\n")
-    f.write("Weather Stats for - {}  || {}\n".format(location.upper(), date_time))
-    f.write("-------------------------------------------------------------\n")
-
-    f.write("\tCurrent temperature is : {:.2f} °C\n".format(temp_city))
-    f.write("\tCurrent weather desc   : " + weather_desc + "\n")
-    f.write("\tCurrent Humidity       : {} %\n".format(hmdt))
-    f.write("\tCurrent wind speed     : {} km/h \n".format(wind_spd))
-    f.close()
-    print("Current temperature is: {:.2f} °C".format(temp_city))
-    print("Current weather desc  : " + weather_desc)
-    print("Current Humidity      :", hmdt, "%")
-    print("Current wind speed    :", wind_spd, "kmph")
-
-except KeyError as KE:
-    print("Enter a valid city")
+
+# Function to fetch weather data from OpenWeatherMap API
+def fetch_weather(api_key, location):
+    try:
+        # Constructing the API link with the provided API key and location
+        complete_api_link = f"https://api.openweathermap.org/data/2.5/weather?q={location}&appid={api_key}"
+
+        # Sending GET request to OpenWeatherMap API
+        api_link = requests.get(complete_api_link)
+
+        # Parsing the JSON response
+        api_data = api_link.json()
+
+        # Returning the fetched weather data
+        return api_data
+
+    # Handling exceptions related to request errors
+    except requests.exceptions.RequestException as e:
+        print("Error fetching weather data:", e)
+        return None
+
+
+# Function to write weather information to a text file
+def write_to_file(location, weather_data):
+    try:
+        # Opening the file "weatherinfo.txt" in write mode
+        with open("weatherinfo.txt", "w+") as f:
+            # Getting the current date and time
+            date_time = datetime.now().strftime("%d %b %Y | %I:%M:%S %p")
+
+            # Writing header information to the file
+            f.write("-------------------------------------------------------------\n")
+            f.write(f"Weather Stats for - {location.upper()}  || {date_time}\n")
+            f.write("-------------------------------------------------------------\n")
+
+            # Writing temperature information to the file
+            if "main" in weather_data and "temp" in weather_data["main"]:
+                f.write("\tCurrent temperature is : {:.2f} °C\n".format(weather_data["main"]["temp"] - 273.15))
+
+            # Writing weather description information to the file
+            if "weather" in weather_data and weather_data["weather"]:
+                f.write("\tCurrent weather desc   : " + weather_data["weather"][0]["description"] + "\n")
+
+            # Writing humidity information to the file
+            if "main" in weather_data and "humidity" in weather_data["main"]:
+                f.write("\tCurrent Humidity       : {} %\n".format(weather_data["main"]["humidity"]))
+
+            # Writing wind speed information to the file
+            if "wind" in weather_data and "speed" in weather_data["wind"]:
+                f.write("\tCurrent wind speed     : {} km/h \n".format(weather_data["wind"]["speed"]))
+
+        # Printing confirmation message after writing to file
+        print("Weather information written to weatherinfo.txt")
+
+    # Handling IOError when writing to file
+    except IOError as e:
+        print("Error writing to file:", e)
+
+
+# Main function
+def main():
+    # Printing welcome messages and instructions
+    print("Welcome to the Weather Information App!")
+    print("You need an API key to access weather data from OpenWeatherMap.")
+    print("You can obtain your API key by signing up at https://home.openweathermap.org/users/sign_up")
+
+    # Prompting the user to input API key and city name
+    api_key = input("Please enter your OpenWeatherMap API key: ")
+    location = input("Enter the city name: ")
+
+    # Fetching weather data using the provided API key and location
+    weather_data = fetch_weather(api_key, location)
+
+    # Checking if weather data was successfully fetched
+    if weather_data:
+        # Writing weather information to file
+        write_to_file(location, weather_data)
+
+        # Printing weather information to console
+        print("Current temperature is: {:.2f} °C".format(weather_data["main"]["temp"] - 273.15))
+        print("Current weather desc  : " + weather_data["weather"][0]["description"])
+        print("Current Humidity      :", weather_data["main"]["humidity"], "%")
+        print("Current wind speed    :", weather_data["wind"]["speed"], "kmph")
+    else:
+        # Printing error message if weather data fetching fails
+        print("Failed to fetch weather data. Please check your input and try again.")
+
+
+# Ensuring the main function is executed when the script is run
+if __name__ == "__main__":
+    main()

projects/API Based Weather Report/README.md

@@ -0,0 +1,48 @@
+# Weather Information App
+
+Welcome to the Weather Information App! This application allows users to fetch current weather information for a specific city using the OpenWeatherMap API. The fetched data is then displayed on the console and saved to a text file for future reference.
+
+## Features
+
+- Fetches current weather data from OpenWeatherMap API.
+- Displays weather information including temperature, weather description, humidity, and wind speed.
+- Writes weather information to a text file for offline access.
+
+## Prerequisites
+
+- Python 3.x installed on your system.
+- OpenWeatherMap API key. You can obtain it by signing up at [OpenWeatherMap](https://home.openweathermap.org/users/sign_up).
+
+## Usage
+
+1. Obtain your OpenWeatherMap API key by signing up at [OpenWeatherMap](https://home.openweathermap.org/users/sign_up).
+
+2. Run the application:
+
+    ```bash
+    python weather_app.py
+    ```
+
+## Usage
+
+1. Obtain your OpenWeatherMap API key by signing up at [OpenWeatherMap](https://home.openweathermap.org/users/sign_up).
+
+2. Run the application:
+
+    ```bash
+    python weather_app.py
+    ```
+
+3. Follow the on-screen prompts to enter your API key and the city name for which you want to fetch weather information.
+
+   **Note:** When entering the city name, ensure to provide the following:
+   - Exact City Name: Spell the city name correctly to ensure accurate results (e.g., "New York", "London").
+   - City Name and Country Code (Optional): Use the format "City, Country Code" to specify the country if needed (e.g., "London, UK", "Springfield, US").
+   - Special Characters: Input special characters or diacritics correctly if applicable (e.g., "Paris", "München").
+   - Alternative Names: Use alternative or local names if known (e.g., "Mumbai" for "Bombay").
+   - City Name with Spaces: Input the city name with spaces as it appears (e.g., "Los Angeles", "San Francisco").
+   - City District or Area (Optional): Specify a district or area within larger cities for more localized weather data (e.g., "Manhattan, New York", "Shinjuku, Tokyo").
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.