Updated Main.py, Readme, Requirements, Docstrings, Tests Files

Author: sue-lim

Currency Script/main.py

@@ -1,2 +1,38 @@
-# TODO IMPORT API / CONVERTER / CURRENCY MODULES
-# TODO UPDATE / POPULATE MAIN TO ENSURE THERE IS A INTUITIVE SIMPLE UI
+"""
+main.py - Simple CLI interface for Currency Converter
+
+Prompts user for input currencies and amount, and displays the converted value.
+"""
+
+from converter import CurrencyConverter
+
+def main():
+    """
+    Run the interactive currency converter CLI loop.
+    Prompts user for source and target currencies and amount to convert.
+    Continues until the user types 'no' to exit.
+    """
+    print("Welcome to the Currency Converter\n")
+
+    converter = CurrencyConverter()
+
+    while True:
+        try:
+            from_currency = input("Enter source currency code (e.g., AUD): ").strip().upper()
+            to_currency = input("Enter target currency code (e.g., USD): ").strip().upper()
+            amount = float(input(f"Enter amount in {from_currency}: "))
+
+            converted = converter.convert(from_currency, to_currency, amount)
+            print(f"\n✅ {amount} {from_currency} = {converted} {to_currency}\n")
+
+        except ValueError as e:
+            print(f"❌ Error: {e}\n")
+
+        # Ask to convert another or exit
+        again = input("Do you want to convert another amount? (yes/no): ").strip().lower()
+        if again != "yes":
+            print("Thank you for using the Currency Converter. Goodbye!")
+            break
+
+if __name__ == "__main__":
+    main()

Currency Script/readme.md

@@ -1 +1,57 @@
-# TODO - UPDATE README
+Currency Converter
+==================
+
+A simple Python CLI application that converts an amount from one currency to another
+using live exchange rates fetched from an open API.
+
+Modules:
+--------
+
+1. **api_handler.py**
+   - Handles fetching exchange rate data from the online API.
+
+2. **currencies.py**
+   - Provides utility functions to list supported currencies and validate currency codes.
+
+3. **converter.py**
+   - Contains the core logic to convert between currencies using the exchange rates.
+
+4. **main.py**
+   - CLI interface where users input the currencies and amount to convert.
+
+5. **test_*.py**
+   - Unit tests for each module to ensure functionality.
+
+Requirements:
+-------------
+- Python 3.7+
+- `requests` library
+
+Install dependencies:
+---------------------
+Run the following command to install dependencies:
+- pip install -r requirements.txt
+
+How to Use:
+-----------
+Run the main script from the terminal:
+
+Follow the prompts to enter:
+- Source currency code (e.g., USD)
+- Target currency code (e.g., AUD)
+- Amount to convert
+
+The app will display the converted amount and allow you to repeat or exit.
+
+Testing:
+--------
+To run tests:
+- python -m unittest discover
+
+Note:
+-----
+The conversion is based on live exchange rates retrieved from:
+https://open.er-api.com/v6/latest
+
+Make sure you are connected to the internet when running the app.
+

Currency Script/requirements.txt

@@ -1 +1 @@
-# TODO - UPDATE REQUIREMENTS TO NOTE INSTALLS ARE NOTED
+requests

Currency Script/setup.py

@@ -1 +1,9 @@
-# UPDATE SETUP TO NOTE SET UP / PACKAGES
+from setuptools import setup
+
+setup(
+    name="currency_converter",
+    version="0.1",
+    install_requires=[
+        "requests"
+    ],
+)

Currency Script/src/api_handler.py

@@ -1,15 +1,23 @@
 import requests
 
 def get_exchange_data(api_url: str = "https://open.er-api.com/v6/latest") -> dict:
-    """Fetch latest exchange data from the API."""
+    """
+    Retrieve the latest foreign exchange rates from the specified API.
+
+    Args:
+        api_url (str): Endpoint to fetch exchange data from. Defaults to the open.er-api URL.
+
+    Returns:
+        dict: A dictionary containing the base currency, timestamp, and exchange rates.
+
+    Raises:
+        Exception: If the API request fails or returns a non-200 status.
+    """
     response = requests.get(api_url)
     if response.status_code != 200:
         raise Exception(f"API request failed with status {response.status_code}")
 
     data = response.json()
-    # Ensure response was successful
-    if data.get("result") != "success":
-        raise Exception(f"API returned error: {data.get('error-type', 'Unknown error')}")
 
     return data  # Includes 'base_code', 'time_last_update_utc', and 'rates'
 

Currency Script/src/converter.py

@@ -1,7 +1,3 @@
-"""
-CurrencyConverter: Converts an amount from one currency to another using live exchange rates.
-"""
-
 from api_handler import get_exchange_data
 
 class CurrencyConverter:
@@ -35,7 +31,8 @@ def convert(self, from_currency: str, to_currency: str, amount: float) -> float:
         converted_amount = round(amount_in_base * self.rates[to_currency], 2)
         return converted_amount
 
-# --- DEBUG / MANUAL TEST ---
+# --- DEBUG / MANUAL TEST SECTION ---
+# This section runs only when you run this file directly (not when imported elsewhere)
 if __name__ == "__main__":
     print("Running manual test for CurrencyConverter...\n")
 

Currency Script/src/currencies.py

@@ -1,11 +1,28 @@
 from api_handler import get_exchange_data
 
-# Returns a list of all supported currency codes.
 def get_supported_currencies(rates):
+    """
+    Return a list of supported currency codes from the rates dictionary.
+
+    Args:
+        rates (dict): Dictionary of currency codes and their exchange rates.
+
+    Returns:
+        list: List of supported currency codes (e.g., ['USD', 'EUR']).
+    """
     return list(rates.keys())
 
-# Checks if a currency code is supported.
 def is_valid_currency(currency_code, rates):
+    """
+    Check if the given currency code is valid and supported.
+
+    Args:
+        currency_code (str): Currency code to validate (e.g., 'USD').
+        rates (dict): Dictionary of available exchange rates.
+
+    Returns:
+        bool: True if the currency code exists in the rates, False otherwise.
+    """
     return currency_code.upper() in rates
 
 # --- DEBUG / MANUAL TEST SECTION ---