Currency Converter

README.md

@@ -1,13 +1,42 @@
----
-title: Currency Converter
-emoji: 🔥
-colorFrom: indigo
-colorTo: purple
-sdk: streamlit
-sdk_version: 1.39.0
-app_file: app.py
-pinned: false
-license: mit
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Currency Converter Web App
+
+## Author:
+- **Name**: [Your Name]
+- **Student ID**: [Your Student ID]
+
+## Project Description:
+
+This project is a Currency Converter web app built using Python and Streamlit. It allows users to convert between different currencies using both the latest and historical exchange rates retrieved from the Frankfurter API.
+
+### Key Features:
+1. Convert an amount between two currencies using the latest conversion rate.
+2. Convert an amount using a historical exchange rate for a selected date.
+3. Display the conversion rate, converted amount, and inverse conversion rate.
+
+### Files in the Project:
+- **app.py**: Main Streamlit Python script used for managing users’ inputs and displaying results.
+- **api.py**: Python script that contains the code for making API calls to fetch available currencies.
+- **frankfurter.py**: Python script containing functions for calling relevant Frankfurter endpoints and extracting information (latest and historical rates).
+- **currency.py**: Python script used for formatting the results displayed in the Streamlit app.
+- **README.md**: Project documentation with details, functions list, and instructions for running the web app.
+
+### Python Functions:
+- `get_currencies()`: Fetches the list of available currencies from the Frankfurter API.
+- `get_latest_rate(from_currency, to_currency)`: Fetches the latest conversion rate from the Frankfurter API.
+- `get_historical_rate(from_currency, to_currency, date)`: Fetches the historical conversion rate for a specific date from the Frankfurter API.
+- `format_conversion_result(date, from_currency, to_currency, rate, from_amount, to_amount, inverse_rate)`: Formats the conversion results for display in the Streamlit app.
+
+### How to Run the Web App:
+Install the required dependencies:
+
+```bash
+pip install streamlit requests
+              or
+pip install -r requirements.txt
+```
+
+Run the Streamlit app:
+
+```bash 
+streamlit run app.py
+```

api.py

@@ -3,10 +3,7 @@ import requests
 BASE_URL = "https://api.frankfurter.app"
 
 def get_currencies():
-    """
-    Fetch the list of available currencies from Frankfurter API.
-    Returns a list of currency codes.
-    """
+
     response = requests.get(f"{BASE_URL}/currencies")
     if response.status_code == 200:
         currencies = response.json()

app.py

@@ -10,7 +10,7 @@ st.title("Currency Converter")
 currencies = get_currencies()
 
 # Input elements
-amount = st.number_input("Enter the amount to be converted:", min_value=0.0, value=0.0)
+amount = st.number_input("Enter the amount to be converted:", min_value=0.0, value=100.0)
 from_currency = st.selectbox("From currency:", currencies)
 to_currency = st.selectbox("To currency:", currencies)
 

frankfurter.py

@@ -3,16 +3,7 @@ import requests
 BASE_URL = "https://api.frankfurter.app"
 
 def get_latest_rate(from_currency, to_currency):
-    """
-    Fetch the latest conversion rate from Frankfurter API.
-    
-    Args:
-        from_currency: Currency code to convert from.
-        to_currency: Currency code to convert to.
-    
-    Returns:
-        The latest conversion rate.
-    """
+ 
     response = requests.get(f"{BASE_URL}/latest?from={from_currency}&to={to_currency}")
     if response.status_code == 200:
         data = response.json()
@@ -21,17 +12,7 @@ def get_latest_rate(from_currency, to_currency):
         raise Exception("Failed to fetch the latest rate")
 
 def get_historical_rate(from_currency, to_currency, date):
-    """
-    Fetch the historical conversion rate for a specific date from Frankfurter API.
-    
-    Args:
-        from_currency: Currency code to convert from.
-        to_currency: Currency code to convert to.
-        date: Date for which to fetch the rate (in YYYY-MM-DD format).
-    
-    Returns:
-        The historical conversion rate.
-    """
+   
     response = requests.get(f"{BASE_URL}/{date}?from={from_currency}&to={to_currency}")
     if response.status_code == 200:
         data = response.json()