Merge pull request #8 from HarshitDalal/F-4_humanize_number

F 4 humanize number

Author: HarshitDalal

NumWord/__init__.py

@@ -1,2 +1,4 @@
 from .number_to_word import NumberToWord
 from .word_to_number import WordToNumber
+from .humanize_number import HumanizeNumber
+from .currency import Currency

NumWord/currency.py

@@ -0,0 +1,114 @@
+import os
+import json
+import requests
+from datetime import datetime
+
+from utility.symboles import CURRENCY_SYMBOLS
+
+
+class Currency:
+    __FILE_NAME = os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'utility', 'exchange_rates.json')
+    __BASE_CURRENCY = "USD"
+
+    def __init__(self):
+        self.__load_or_update_rates()
+
+    def __fetch_exchange_rates(self):
+        """
+        Fetch all exchange rates for the base currency from an API.
+
+        Returns:
+            dict: A dictionary containing the date, rates, and base currency.
+
+        Raises:
+            ConnectionError: If the API request fails or returns an error.
+        """
+        url = f"https://open.er-api.com/v6/latest/{self.__BASE_CURRENCY}"
+        response = requests.get(url)
+        format_data = {}
+        if response.status_code == 200:
+            data = response.json()
+            format_data["date"] = datetime.now().strftime("%Y-%m-%d")
+            format_data["rates"] = data["rates"]
+            format_data["Base"] = data["base_code"]
+            return format_data
+        else:
+            raise ConnectionError("Failed to fetch exchange rates")
+
+    def __save_exchange_rates(self, data):
+        """
+        Save exchange rates to a JSON file.
+
+        Args:
+            data (dict): The exchange rates data to be saved.
+        """
+        with open(self.__FILE_NAME, "w", encoding="utf-8") as file:
+            json.dump(data, file, indent=4)
+
+    def __load_exchange_rates(self):
+        """
+        Load exchange rates from file if valid.
+
+        Returns:
+            dict|None: The loaded exchange rates data if valid, or `None` if not valid.
+        """
+        if os.path.exists(self.__FILE_NAME):
+            with open(self.__FILE_NAME, "r") as file:
+                data = json.load(file)
+                if data.get("date") == datetime.now().strftime("%Y-%m-%d"):
+                    return data
+        return None
+
+    def __load_or_update_rates(self):
+        """
+        Load exchange rates from file or update them by fetching from the API.
+        """
+        data = self.__load_exchange_rates()
+        if data is None:
+            data = self.__fetch_exchange_rates()
+            self.__save_exchange_rates(data)
+        self.__rates = data["rates"]
+
+    def __get_exchange_rate(self, from_currency, to_currency):
+        """
+        Get exchange rate from stored data.
+
+        Args:
+            from_currency (str): The currency from which to convert.
+            to_currency (str): The currency to which to convert.
+
+        Returns:
+            float: The exchange rate for converting from `from_currency` to `to_currency`.
+
+        Raises:
+            ValueError: If the exchange rate is not available.
+        """
+        if from_currency == self.__BASE_CURRENCY:
+            return self.__rates.get(to_currency)
+        elif to_currency == self.__BASE_CURRENCY:
+            return 1 / self.__rates.get(from_currency)
+        else:
+            return self.__rates.get(to_currency) / self.__rates.get(from_currency)
+
+    def convert(self, amount, from_currency, to_currency, with_symbol=True):
+        """
+        Convert an amount from one currency to another.
+
+        Args:
+            amount (float): The amount of money to convert.
+            from_currency (str): The currency to convert from.
+            to_currency (str): The currency to convert to.
+            with_symbol (bool): Whether to include the currency symbol in the result (default is `True`).
+
+        Returns:
+            str: The converted amount formatted as a string, with or without the currency symbol.
+
+        Raises:
+            ValueError: If the exchange rate for the currencies is not found.
+        """
+        rate = self.__get_exchange_rate(from_currency, to_currency)
+        if rate is None:
+            raise ValueError("Invalid currency or rate not found")
+        converted_amount = amount * rate
+        return f'{converted_amount:.2f} {to_currency}' if not with_symbol else \
+            f'{CURRENCY_SYMBOLS[to_currency]} {converted_amount:.2f}'

NumWord/humanize_number.py

@@ -0,0 +1,36 @@
+from utility import GetLanguage
+
+
+class HumanizeNumber:
+    def __init__(self):
+        self.suffixes = None
+
+    def convert(self, number, lang='en', to_lang=None):
+        if to_lang is not None:
+            return self.__convert_to_lang(number, lang, to_lang)
+        else:
+            self.__get_word(lang)
+            for value, suffix in self.suffixes:
+                if number >= 10 ** value:
+                    formatted_num = number / 10 ** value
+                    if formatted_num.is_integer():
+                        return f"{int(formatted_num)}{suffix}"
+                    formatted_str = f"{formatted_num:.2f}"
+                    if formatted_str[-1] == "0":
+                        formatted_str = f"{formatted_num:.1f}"
+                    return f"{formatted_str}{suffix}"
+
+        return str(number)
+
+    def __convert_to_lang(self, humanize_number, from_lang, to_lang):
+        from_suffix = GetLanguage().get_language(from_lang)[3][::-1]
+
+        for value, suffix in from_suffix:
+            if suffix in humanize_number:
+                number = float(humanize_number.replace(suffix, "")) * 10 ** value
+                return self.convert(number, to_lang)
+
+        return humanize_number
+
+    def __get_word(self, lang='en'):
+        self.suffixes = GetLanguage().get_language(lang)[3][::-1]

README.md

@@ -15,6 +15,9 @@ NumWord is a Python package that converts numbers written in words to their nume
 - Convert numbers to words.
 - Supports English language.
 - Supports Hindi language.
+- Supports convert number into humanize number e.g.
+    - 1500000 -> 1.5M
+    - 1.5M -> 10L / 10 लाख
 
 ## Installation
 
@@ -25,40 +28,67 @@ pip install -r requirements.txt
 ```
 
 ## Usage
+
 Here is an example of how to use the NumWord package:
 
+### Convert number word into number
+
 ```python
-from NumWord import WordToNumber, NumberToWord
+from NumWord import WordToNumber
 
-# Convert words to numbers in English
 word_to_num_converter = WordToNumber()
+
+# Convert words to numbers in English
 result = word_to_num_converter.convert("one hundred twenty three point four five six")
 print(result)  # Output: 123.456
 
-# Convert numbers to words in English
-num_to_word_converter = NumberToWord()
-result = num_to_word_converter.convert(123.456)
-print(result)  # Output: one hundred twenty-three point four five six
-
-
 # Convert words to numbers in Hindi
-word_to_num_converter = WordToNumber()
 result = word_to_num_converter.convert("एक सौ तेईस दशमलव चार पांच छह", lang='hi')
 print(result)  # Output: 123.456
+``` 
+
+### Convert number into number word
+
+```python
+from NumWord import NumberToWord
 
-# Convert numbers to words in Hindi
 num_to_word_converter = NumberToWord()
+
+# Convert numbers to words in English
+result = num_to_word_converter.convert(123.456)
+print(result)  # Output: one hundred twenty-three point four five six
+
+# Convert numbers to words in Hindi
 result = num_to_word_converter.convert(123.456, lang='hi')
 print(result)  # Output: एक सौ तेईस दशमलव चार पांच छह
-``` 
+```
 
+### Convert number into Humanize Number or convert one number system to another humanize number system
+
+```python
+from NumWord import HumanizeNumber
+
+humanize_number = HumanizeNumber()
+
+result = humanize_number.convert(1500000, lang='en')
+print(result)  # Output: 1.5M
+
+result = humanize_number.convert("1.5M", lang="en", to_lang="hi")
+print(result)  # Output: 15 लाख
+
+result = humanize_number.convert("1.5M", lang="en", to_lang="en-hi")
+print(result)  # Output: 15L
+```
 
 ## Running Tests
+
 To run the tests, use the following command:
+
 ```bash
 python -m unittest discover tests
 ```
 
 ## License
+
 This project is licensed under the MIT License - see the MIT License file for details.
 

pyproject.toml

@@ -1,3 +1,3 @@
 [build-system]
-requires = ["setuptools>=42", "wheel"]
+requires = ["setuptools>=42", "wheel", "requests"]
 build-backend = "setuptools.build_meta"

requirements.txt

@@ -2,7 +2,7 @@
 
 setup(
     name='NumWord',
-    version='0.0.1',
+    version='0.0.3',
     packages=find_packages(),
     install_requires=[],
     author='Harshit Dalal',
@@ -17,8 +17,8 @@
         'Operating System :: OS Independent',
     ],
     keywords=[
-        'number', 'word', 'conversion',
-        'number to word', 'word to number'
+        'number', 'word', 'conversion', 'numbers2words',
+        'number to word', 'word to number', 'num2words', 'words2number'
     ],
     python_requires='>=3.6',
-)
+)

setup.py

@@ -0,0 +1,63 @@
+import unittest
+
+from Logs import LoggerConfig
+from NumWord import Currency
+import os
+
+
+class TestCurrency(unittest.TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        cls.logger = LoggerConfig(__name__).get_logger()
+        cls.logger.info("TestCurrency started.")
+        cls.currency = Currency()
+
+    @classmethod
+    def tearDownClass(cls):
+        cls.logger.info("TestCurrency completed. \n -----------------")
+
+    def test_currency_conversion_valid(self):
+
+        result = self.currency.convert(100, "USD", "EUR", with_symbol=False)
+        self.assertIsInstance(result, str)
+        self.logger.info(f"Test Convert 100 USD to EUR without symbol -> {result}")
+        self.assertTrue("EUR" in result)
+
+        result = self.currency.convert(50, "EUR", "INR", with_symbol=True)
+        self.assertIsInstance(result, str)
+        self.logger.info(f"Test Convert 50 EUR to INR with symbol -> {result}")
+        self.assertTrue("₹" in result)
+
+    def test_invalid_currency(self):
+        self.logger.info("Test Invalid Currency Code")
+        with self.assertRaises(ValueError):
+            self.currency.convert(100, "USD", "XYZ", with_symbol=True)  # Invalid currency code
+
+    def test_load_exchange_rates_from_file(self):
+        rates = self.currency._Currency__rates
+        self.assertIsInstance(rates, dict)
+        self.logger.info(f"Test Exchange rates load successfully: Total rates found -> {len(rates)}")
+        self.assertGreater(len(rates), 0)
+
+    def test_fetch_exchange_rates(self):
+
+        data = self.currency._Currency__fetch_exchange_rates()
+        self.logger.info(f"Test Base Code is USD -> {data['Base']}")
+        self.assertEqual(data["Base"], "USD")
+        self.assertGreater(len(data["rates"]), 0)
+
+    def test_currency_conversion_with_live_data(self):
+
+        self.logger.info(f"Test Cases with live exchange rates")
+        result = self.currency.convert(100, "USD", "EUR", with_symbol=False)
+        self.assertIsInstance(result, str)
+        self.assertTrue("EUR" in result)
+
+        result = self.currency.convert(100, "USD", "EUR", with_symbol=True)
+        self.assertIsInstance(result, str)
+        self.assertTrue("€" in result)
+
+
+if __name__ == '__main__':
+    unittest.main()