#11 currency symbol

MANIFEST.in

@@ -1,2 +1,3 @@
 include README.md
 include LICENSE.txt
+include forex_python/raw_data/currencies.json

README.md

@@ -2,6 +2,7 @@ forex-python
 ============
 [![Build Status](https://travis-ci.org/MicroPyramid/forex-python.svg?branch=master)](https://travis-ci.org/MicroPyramid/forex-python)
 [![Coverage Status](https://coveralls.io/repos/github/MicroPyramid/forex-python/badge.svg?branch=master)](https://coveralls.io/github/MicroPyramid/forex-python?branch=master)
+[![Python Support](https://img.shields.io/badge/python-2.7%2C%203.3%2C%203.4%2C%203.5-blue.svg)](https://pypi.python.org/pypi/forex-python)
 [![Code Health](https://landscape.io/github/MicroPyramid/forex-python/master/landscape.svg?style=plastic)](https://landscape.io/github/MicroPyramid/forex-python/master)
 
 Free Foreign exchange rates and currency conversion.
@@ -68,12 +69,19 @@ Convert amount from USD to INR based on 2010-03-01 rates
 
 RatesNotAvailableError for invalid currency codes and missing currency code from source:
 ```python
-    >>> c.get_rate('XYZ', 'INR')
-    Traceback (most recent call last):
-    RatesNotAvailableError: Currency XYZ => INR rate not available for Date latest.
+>>> c.get_rate('XYZ', 'INR')
+Traceback (most recent call last):
+RatesNotAvailableError: Currency XYZ => INR rate not available for Date latest.
 ```
 
-Compleate [Documentation](http://forex-python.readthedocs.org/en/latest/?badge=latest)
+Get currency symbol using currency code
+```python
+>>> from forex_python.converter import CurrencyCodes
+>>> c = CurrencyCodes()
+>>> print c.get_symbol('GBP')
+�
+```
 
-We welcome your feedback and support. found bug raise github issue.
+Complete [Documentation](http://forex-python.readthedocs.org/en/latest/?badge=latest)
 
+We welcome your feedback and support. found bug raise github issue.

docs/source/usage.rst

@@ -1,6 +1,8 @@
 Usage Examples:
 ===============
 
+Currency Rates
+--------------
 1. list all latest currency rates for "USD"::
      >>> from forex_python.converter import CurrencyRates
      >>> c = CurrencyRates()
@@ -32,3 +34,24 @@ Usage Examples:
      datetime.datetime(2014, 5, 23, 18, 36, 28, 151012)
      >>> c.convert('USD', 'INR', 10, date_obj)
      585.09
+
+Currency Symboles & Codes
+-------------------------
+1. Get Currency symbol Using currency code::
+     >>> from forex_python.converter import CurrencyCodes
+     >>> c = CurrencyCodes()
+     >>> c.get_symbol('GBP')
+     u'\xa3'
+     >>> print c.get_symbol('GBP')
+     £
+     >>> print c.get_symbol('EUR')
+     €
+
+2. Get Currency Name using currency code::
+     >>> c.get_currency_name('EUR')
+     u'European Euro'
+     >>> c.get_currency_name('INR')
+     u'Indian rupee'
+
+
+

forex_python/converter.py

@@ -1,3 +1,5 @@
+import os
+import json
 import requests
 
 
@@ -61,3 +63,28 @@ def convert(self, base_cur, dest_cur, amount, date_obj=None):
             converted_amount = rate * amount
             return converted_amount
         raise RatesNotAvailableError("Currency Rates Source Not Ready")
+
+
+class CurrencyCodes:
+
+    def __init__(self):
+        pass
+
+    def _get_data(self, currency_code):
+        file_path = os.path.dirname(os.path.abspath(__file__))
+        with open(file_path+'/raw_data/currencies.json') as f:
+            currency_data = json.loads(f.read())
+        currency_dict = next((item for item in currency_data if item["cc"] == currency_code), None)
+        return currency_dict
+
+    def get_symbol(self, currency_code):
+        currency_dict = self._get_data(currency_code)
+        if currency_dict:
+            return currency_dict.get('symbol')
+        return None
+
+    def get_currency_name(self, currency_code):
+        currency_dict = self._get_data(currency_code)
+        if currency_dict:
+            return currency_dict.get('name')
+        return None

forex_python/raw_data/currencies.json

@@ -0,0 +1,158 @@
+[
+  {"cc":"AED","symbol":"\u062f.\u0625;","name":"UAE dirham"},
+  {"cc":"AFN","symbol":"Afs","name":"Afghan afghani"},
+  {"cc":"ALL","symbol":"L","name":"Albanian lek"},
+  {"cc":"AMD","symbol":"AMD","name":"Armenian dram"},
+  {"cc":"ANG","symbol":"NA\u0192","name":"Netherlands Antillean gulden"},
+  {"cc":"AOA","symbol":"Kz","name":"Angolan kwanza"},
+  {"cc":"ARS","symbol":"$","name":"Argentine peso"},
+  {"cc":"AUD","symbol":"$","name":"Australian dollar"},
+  {"cc":"AWG","symbol":"\u0192","name":"Aruban florin"},
+  {"cc":"AZN","symbol":"AZN","name":"Azerbaijani manat"},
+  {"cc":"BAM","symbol":"KM","name":"Bosnia and Herzegovina konvertibilna marka"},
+  {"cc":"BBD","symbol":"Bds$","name":"Barbadian dollar"},
+  {"cc":"BDT","symbol":"\u09f3","name":"Bangladeshi taka"},
+  {"cc":"BGN","symbol":"BGN","name":"Bulgarian lev"},
+  {"cc":"BHD","symbol":".\u062f.\u0628","name":"Bahraini dinar"},
+  {"cc":"BIF","symbol":"FBu","name":"Burundi franc"},
+  {"cc":"BMD","symbol":"BD$","name":"Bermudian dollar"},
+  {"cc":"BND","symbol":"B$","name":"Brunei dollar"},
+  {"cc":"BOB","symbol":"Bs.","name":"Bolivian boliviano"},
+  {"cc":"BRL","symbol":"R$","name":"Brazilian real"},
+  {"cc":"BSD","symbol":"B$","name":"Bahamian dollar"},
+  {"cc":"BTN","symbol":"Nu.","name":"Bhutanese ngultrum"},
+  {"cc":"BWP","symbol":"P","name":"Botswana pula"},
+  {"cc":"BYR","symbol":"Br","name":"Belarusian ruble"},
+  {"cc":"BZD","symbol":"BZ$","name":"Belize dollar"},
+  {"cc":"CAD","symbol":"$","name":"Canadian dollar"},
+  {"cc":"CDF","symbol":"F","name":"Congolese franc"},
+  {"cc":"CHF","symbol":"Fr.","name":"Swiss franc"},
+  {"cc":"CLP","symbol":"$","name":"Chilean peso"},
+  {"cc":"CNY","symbol":"\u00a5","name":"Chinese/Yuan renminbi"},
+  {"cc":"COP","symbol":"Col$","name":"Colombian peso"},
+  {"cc":"CRC","symbol":"\u20a1","name":"Costa Rican colon"},
+  {"cc":"CUC","symbol":"$","name":"Cuban peso"},
+  {"cc":"CVE","symbol":"Esc","name":"Cape Verdean escudo"},
+  {"cc":"CZK","symbol":"K\u010d","name":"Czech koruna"},
+  {"cc":"DJF","symbol":"Fdj","name":"Djiboutian franc"},
+  {"cc":"DKK","symbol":"Kr","name":"Danish krone"},
+  {"cc":"DOP","symbol":"RD$","name":"Dominican peso"},
+  {"cc":"DZD","symbol":"\u062f.\u062c","name":"Algerian dinar"},
+  {"cc":"EEK","symbol":"KR","name":"Estonian kroon"},
+  {"cc":"EGP","symbol":"\u00a3","name":"Egyptian pound"},
+  {"cc":"ERN","symbol":"Nfa","name":"Eritrean nakfa"},
+  {"cc":"ETB","symbol":"Br","name":"Ethiopian birr"},
+  {"cc":"EUR","symbol":"\u20ac","name":"European Euro"},
+  {"cc":"FJD","symbol":"FJ$","name":"Fijian dollar"},
+  {"cc":"FKP","symbol":"\u00a3","name":"Falkland Islands pound"},
+  {"cc":"GBP","symbol":"\u00a3","name":"British pound"},
+  {"cc":"GEL","symbol":"GEL","name":"Georgian lari"},
+  {"cc":"GHS","symbol":"GH\u20b5","name":"Ghanaian cedi"},
+  {"cc":"GIP","symbol":"\u00a3","name":"Gibraltar pound"},
+  {"cc":"GMD","symbol":"D","name":"Gambian dalasi"},
+  {"cc":"GNF","symbol":"FG","name":"Guinean franc"},
+  {"cc":"GQE","symbol":"CFA","name":"Central African CFA franc"},
+  {"cc":"GTQ","symbol":"Q","name":"Guatemalan quetzal"},
+  {"cc":"GYD","symbol":"GY$","name":"Guyanese dollar"},
+  {"cc":"HKD","symbol":"HK$","name":"Hong Kong dollar"},
+  {"cc":"HNL","symbol":"L","name":"Honduran lempira"},
+  {"cc":"HRK","symbol":"kn","name":"Croatian kuna"},
+  {"cc":"HTG","symbol":"G","name":"Haitian gourde"},
+  {"cc":"HUF","symbol":"Ft","name":"Hungarian forint"},
+  {"cc":"IDR","symbol":"Rp","name":"Indonesian rupiah"},
+  {"cc":"ILS","symbol":"\u20aa","name":"Israeli new sheqel"},
+  {"cc":"INR","symbol":"\u20B9","name":"Indian rupee"},
+  {"cc":"IQD","symbol":"\u062f.\u0639","name":"Iraqi dinar"},
+  {"cc":"IRR","symbol":"IRR","name":"Iranian rial"},
+  {"cc":"ISK","symbol":"kr","name":"Icelandic kr\u00f3na"},
+  {"cc":"JMD","symbol":"J$","name":"Jamaican dollar"},
+  {"cc":"JOD","symbol":"JOD","name":"Jordanian dinar"},
+  {"cc":"JPY","symbol":"\u00a5","name":"Japanese yen"},
+  {"cc":"KES","symbol":"KSh","name":"Kenyan shilling"},
+  {"cc":"KGS","symbol":"\u0441\u043e\u043c","name":"Kyrgyzstani som"},
+  {"cc":"KHR","symbol":"\u17db","name":"Cambodian riel"},
+  {"cc":"KMF","symbol":"KMF","name":"Comorian franc"},
+  {"cc":"KPW","symbol":"W","name":"North Korean won"},
+  {"cc":"KRW","symbol":"W","name":"South Korean won"},
+  {"cc":"KWD","symbol":"KWD","name":"Kuwaiti dinar"},
+  {"cc":"KYD","symbol":"KY$","name":"Cayman Islands dollar"},
+  {"cc":"KZT","symbol":"T","name":"Kazakhstani tenge"},
+  {"cc":"LAK","symbol":"KN","name":"Lao kip"},
+  {"cc":"LBP","symbol":"\u00a3","name":"Lebanese lira"},
+  {"cc":"LKR","symbol":"Rs","name":"Sri Lankan rupee"},
+  {"cc":"LRD","symbol":"L$","name":"Liberian dollar"},
+  {"cc":"LSL","symbol":"M","name":"Lesotho loti"},
+  {"cc":"LTL","symbol":"Lt","name":"Lithuanian litas"},
+  {"cc":"LVL","symbol":"Ls","name":"Latvian lats"},
+  {"cc":"LYD","symbol":"LD","name":"Libyan dinar"},
+  {"cc":"MAD","symbol":"MAD","name":"Moroccan dirham"},
+  {"cc":"MDL","symbol":"MDL","name":"Moldovan leu"},
+  {"cc":"MGA","symbol":"FMG","name":"Malagasy ariary"},
+  {"cc":"MKD","symbol":"MKD","name":"Macedonian denar"},
+  {"cc":"MMK","symbol":"K","name":"Myanma kyat"},
+  {"cc":"MNT","symbol":"\u20ae","name":"Mongolian tugrik"},
+  {"cc":"MOP","symbol":"P","name":"Macanese pataca"},
+  {"cc":"MRO","symbol":"UM","name":"Mauritanian ouguiya"},
+  {"cc":"MUR","symbol":"Rs","name":"Mauritian rupee"},
+  {"cc":"MVR","symbol":"Rf","name":"Maldivian rufiyaa"},
+  {"cc":"MWK","symbol":"MK","name":"Malawian kwacha"},
+  {"cc":"MXN","symbol":"$","name":"Mexican peso"},
+  {"cc":"MYR","symbol":"RM","name":"Malaysian ringgit"},
+  {"cc":"MZM","symbol":"MTn","name":"Mozambican metical"},
+  {"cc":"NAD","symbol":"N$","name":"Namibian dollar"},
+  {"cc":"NGN","symbol":"\u20a6","name":"Nigerian naira"},
+  {"cc":"NIO","symbol":"C$","name":"Nicaraguan c\u00f3rdoba"},
+  {"cc":"NOK","symbol":"kr","name":"Norwegian krone"},
+  {"cc":"NPR","symbol":"NRs","name":"Nepalese rupee"},
+  {"cc":"NZD","symbol":"NZ$","name":"New Zealand dollar"},
+  {"cc":"OMR","symbol":"OMR","name":"Omani rial"},
+  {"cc":"PAB","symbol":"B./","name":"Panamanian balboa"},
+  {"cc":"PEN","symbol":"S/.","name":"Peruvian nuevo sol"},
+  {"cc":"PGK","symbol":"K","name":"Papua New Guinean kina"},
+  {"cc":"PHP","symbol":"\u20b1","name":"Philippine peso"},
+  {"cc":"PKR","symbol":"Rs.","name":"Pakistani rupee"},
+  {"cc":"PLN","symbol":"z\u0142","name":"Polish zloty"},
+  {"cc":"PYG","symbol":"\u20b2","name":"Paraguayan guarani"},
+  {"cc":"QAR","symbol":"QR","name":"Qatari riyal"},
+  {"cc":"RON","symbol":"L","name":"Romanian leu"},
+  {"cc":"RSD","symbol":"din.","name":"Serbian dinar"},
+  {"cc":"RUB","symbol":"R","name":"Russian ruble"},
+  {"cc":"SAR","symbol":"SR","name":"Saudi riyal"},
+  {"cc":"SBD","symbol":"SI$","name":"Solomon Islands dollar"},
+  {"cc":"SCR","symbol":"SR","name":"Seychellois rupee"},
+  {"cc":"SDG","symbol":"SDG","name":"Sudanese pound"},
+  {"cc":"SEK","symbol":"kr","name":"Swedish krona"},
+  {"cc":"SGD","symbol":"S$","name":"Singapore dollar"},
+  {"cc":"SHP","symbol":"\u00a3","name":"Saint Helena pound"},
+  {"cc":"SLL","symbol":"Le","name":"Sierra Leonean leone"},
+  {"cc":"SOS","symbol":"Sh.","name":"Somali shilling"},
+  {"cc":"SRD","symbol":"$","name":"Surinamese dollar"},
+  {"cc":"SYP","symbol":"LS","name":"Syrian pound"},
+  {"cc":"SZL","symbol":"E","name":"Swazi lilangeni"},
+  {"cc":"THB","symbol":"\u0e3f","name":"Thai baht"},
+  {"cc":"TJS","symbol":"TJS","name":"Tajikistani somoni"},
+  {"cc":"TMT","symbol":"m","name":"Turkmen manat"},
+  {"cc":"TND","symbol":"DT","name":"Tunisian dinar"},
+  {"cc":"TRY","symbol":"TRY","name":"Turkish new lira"},
+  {"cc":"TTD","symbol":"TT$","name":"Trinidad and Tobago dollar"},
+  {"cc":"TWD","symbol":"NT$","name":"New Taiwan dollar"},
+  {"cc":"TZS","symbol":"TZS","name":"Tanzanian shilling"},
+  {"cc":"UAH","symbol":"UAH","name":"Ukrainian hryvnia"},
+  {"cc":"UGX","symbol":"USh","name":"Ugandan shilling"},
+  {"cc":"USD","symbol":"US$","name":"United States dollar"},
+  {"cc":"UYU","symbol":"$U","name":"Uruguayan peso"},
+  {"cc":"UZS","symbol":"UZS","name":"Uzbekistani som"},
+  {"cc":"VEB","symbol":"Bs","name":"Venezuelan bolivar"},
+  {"cc":"VND","symbol":"\u20ab","name":"Vietnamese dong"},
+  {"cc":"VUV","symbol":"VT","name":"Vanuatu vatu"},
+  {"cc":"WST","symbol":"WS$","name":"Samoan tala"},
+  {"cc":"XAF","symbol":"CFA","name":"Central African CFA franc"},
+  {"cc":"XCD","symbol":"EC$","name":"East Caribbean dollar"},
+  {"cc":"XDR","symbol":"SDR","name":"Special Drawing Rights"},
+  {"cc":"XOF","symbol":"CFA","name":"West African CFA franc"},
+  {"cc":"XPF","symbol":"F","name":"CFP franc"},
+  {"cc":"YER","symbol":"YER","name":"Yemeni rial"},
+  {"cc":"ZAR","symbol":"R","name":"South African rand"},
+  {"cc":"ZMK","symbol":"ZK","name":"Zambian kwacha"},
+  {"cc":"ZWR","symbol":"Z$","name":"Zimbabwean dollar"}
+]

setup.py

@@ -1,9 +1,10 @@
+import io
 import os
 from setuptools import setup, find_packages
 
 VERSION = '0.2.2'
 
-with open(os.path.join(os.path.dirname(__file__), 'README.md')) as readme:
+with io.open(os.path.join(os.path.dirname(__file__), 'README.md'),  encoding='utf-8', errors='ignore') as readme:
     LONG_DESCRIPTION = readme.read()
 
 

tests/test.py

@@ -1,6 +1,6 @@
 import datetime
 from unittest import TestCase
-from forex_python.converter import CurrencyRates
+from forex_python.converter import CurrencyRates, CurrencyCodes
 from forex_python.converter import RatesNotAvailableError
 
 
@@ -88,3 +88,32 @@ def test_amount_convert_date(self):
     def test_amount_convert_invalid_currency(self):
         # test if amount returned in float
         self.assertRaises(RatesNotAvailableError, self.c.convert, 'ABC', 'XYZ', 10)
+
+
+class TestCurrencySymbol(TestCase):
+    """
+    test currency symbols from currency codes
+    """
+    def setUp(self):
+        self.c = CurrencyCodes()
+
+    def test_with_valid_currency_code(self):
+        self.assertEqual(str(self.c.get_symbol('USD')), 'US$')
+
+    def test_with_invalid_currency_code(self):
+        self.assertFalse(self.c.get_symbol('XYZ'))
+
+
+class TestCurrencyName(TestCase):
+    """
+    test currency name from currency codes
+    """
+    def setUp(self):
+        self.c = CurrencyCodes()
+
+    def test_with_valid_currency_code(self):
+        self.assertEqual(str(self.c.get_currency_name('USD')), 'United States dollar')
+
+    def test_with_invalid_currency_code(self):
+        self.assertFalse(self.c.get_currency_name('XYZ'))
+