[![CI](https://github.com/tammoippen/iso4217parse/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/tammoippen/iso4217parse/actions/workflows/CI.yml)
[![Coverage Status](https://coveralls.io/repos/github/tammoippen/iso4217parse/badge.svg?branch=master)](https://coveralls.io/github/tammoippen/iso4217parse?branch=master)
[![Tested CPython Versions](https://img.shields.io/badge/cpython-3.9%2C%203.10%2C%203.11%2C%203.12%2C%203.13-brightgreen.svg)](https://img.shields.io/badge/cpython-3.9%2C%203.10%2C%203.11%2C%203.12%2C%203.13-brightgreen.svg)
[![Tested PyPy Versions](https://img.shields.io/badge/pypy-3.9%2C%203.10-brightgreen.svg)](https://img.shields.io/badge/pypy-3.9%2C%203.10%2C%203.10-brightgreen.svg)
[![PyPi version](https://img.shields.io/pypi/v/iso4217parse.svg)](https://pypi.python.org/pypi/iso4217parse)
[![PyPi license](https://img.shields.io/pypi/l/iso4217parse.svg)](https://pypi.python.org/pypi/iso4217parse)
# ISO4217 Currency Parser
Parse currencies (symbols and codes) from and to [ISO4217](https://en.wikipedia.org/wiki/ISO_4217).
Similar to [iso4217](https://github.com/spoqa/iso4217) package, but
- data is acquired by scraping Wikipedia (see [below](#data-acquisition)) - this is repeatable and you stay on the most current data
- currency symbols are curated by hand - this allows some fuzzy currency matching
- no download and parsing during install
- no external dependencies (`enum34`)
When you want to _reuse_ the [_data.json_](https://github.com/tammoippen/iso4217parse/blob/master/iso4217parse/data.json) file for your projects, please leave a attribution note. I license the file under (CC BY 4.0).
Install:
```sh
pip install iso4217parse
```
**(If you are required to use python version 2.7 or lower than 3.9, please use version [0.5.1](https://pypi.org/project/iso4217parse/0.5.1/))**
## Documentation
Each currency is modeled as a `collections.namedtuple`:
```python
Currency = namedtuple('Currency', [
'alpha3', # unicode: the ISO4217 alpha3 code
'code_num', # int: the ISO4217 numeric code
'name', # unicode: the currency name
'symbols', # List[unicode]: list of possible symbols;
# first is opinionated choice for representation
'minor', # int: number of decimal digits to round
'countries', # List[unicode]: list of countries that use this currency.
])
```
**parse:** Try to parse the input in a best effort approach by using `by_alpha3()`, `by_code_num()`, ... functions:
```python
In [1]: import iso4217parse
In [2]: iso4217parse.parse('CHF')
Out[2]: [Currency(alpha3='CHF', code_num=756, name='Swiss franc',
symbols=['SFr.', 'fr', 'Fr.', 'F', 'franc', 'francs', 'Franc', 'Francs'],
minor=2, countries=['CH', 'LI'])]
In [3]: iso4217parse.parse(192)
Out[3]:
[Currency(alpha3='CUP', code_num=192, name='Cuban peso',
symbols=['₱', '$', '﹩', '$', 'dollar', 'dollars', 'Dollar', 'Dollars', '$MN', '﹩MN', '$MN'],
minor=2, countries=['CU'])]
In [4]: iso4217parse.parse('Price is 5 €')
Out[4]: [Currency(alpha3='EUR', code_num=978, name='Euro',
symbols=['€', 'euro', 'euros'], minor=2,
countries=['AD', 'AT', 'AX', 'BE', 'BL', 'CY', 'DE', 'EE', 'ES', 'FI',
'FR', 'GF', 'GP', 'GR', 'IE', 'IT', 'LT', 'LU', 'LV', 'MC',
'ME', 'MF', 'MQ', 'MT', 'NL', 'PM', 'PT', 'RE', 'SI', 'SK',
'SM', 'TF', 'VA', 'XK', 'YT'])]
In [5]: iso4217parse.parse('CA﹩15.76')
Out[5]: [Currency(alpha3='CAD', code_num=124, name='Canadian dollar',
symbols=['CA$', 'CA$', '$', '$', 'dollar', 'dollars', 'Dollar', 'Dollars', 'CA﹩', '﹩'],
minor=2, countries=['CA'])]
In [6]: iso4217parse.parse?
Signature: iso4217parse.parse(v, country_code=None)
Docstring:
Try parse `v` to currencies; filter by country_code
If `v` is a number, try `by_code_num()`; otherwise try:
1) if `v` is 3 character uppercase: `by_alpha3()`
2) Exact symbol match: `by_symbol()`
3) Exact country code match: `by_country()`
4) Fuzzy by symbol match heuristic: `by_symbol_match()`
Parameters:
v: Union[unicode, int] Either a iso4217 numeric code or some string
country_code: Optional[unicode] Iso3166 alpha2 country code.
Returns:
List[Currency]: found Currency objects.
```
**by_alpha3:** Get the currency by its iso4217 alpha3 code:
```python
In [1]: import iso4217parse
In [2]: iso4217parse.by_alpha3('CHF')
Out[2]: Currency(alpha3='CHF', code_num=756, name='Swiss franc',
symbols=['SFr.', 'fr', 'Fr.', 'F', 'franc', 'francs', 'Franc', 'Francs'],
minor=2, countries=['CH', 'LI'])
In [3]: iso4217parse.by_alpha3?
Signature: iso4217parse.by_alpha3(code)
Docstring:
Get Currency for ISO4217 alpha3 code
Parameters:
code: unicode An alpha3 iso4217 code.
Returns:
Currency: Currency object for `code`, if available.
```
**by_code_num:** Get the currency by its iso4217 numeric code:
```python
In [1]: import iso4217parse
In [2]: iso4217parse.by_code_num(51)
Out[2]: Currency(alpha3='AMD', code_num=51, name='Armenian dram',
symbols=['֏', 'դր', 'dram'], minor=2, countries=['AM'])
In [3]: iso4217parse.by_code_num?
Signature: iso4217parse.by_code_num(code_num)
Docstring:
Get Currency for ISO4217 numeric code
Parameters:
code_num: int An iso4217 numeric code.
Returns:
Currency: Currency object for `code_num`, if available.
```
**by_country:** Get currencies used in a country:
```python
In [1]: import iso4217parse
In [2]: iso4217parse.country('HK')
Out[2]:
[
Currency(alpha3='HKD', code_num=344, name='Hong Kong dollar',
symbols=['HK$', 'HK$', '$', '$', 'dollar', 'dollars', 'Dollar', 'Dollars', 'HK﹩', '﹩', '元'],
minor=2, countries=['HK']),
Currency(alpha3='CNH', code_num=None, name='Chinese yuan (when traded offshore)',
symbols=['CN¥', '¥', 'CN¥', '¥', 'RMB', '元'],
minor=2, countries=['HK'])
]
In [3]: iso4217parse.country?
Signature: iso4217parse.by_country(country_code)
Docstring:
Get all currencies used in country
Parameters:
country_code: unicode iso3166 alpha2 country code
Returns:
List[Currency]: Currency objects used in country.
```
**by_symbol:** Get currencies that use the given symbol:
```python
In [1]: import iso4217parse
In [2]: iso4217parse.by_symbol('$MN')
Out[2]:
[
Currency(alpha3='CUP', code_num=192, name='Cuban peso',
symbols=['₱', '$', '﹩', '$', 'dollar', 'dollars', 'Dollar', 'Dollars', '$MN', '﹩MN', '$MN'],
minor=2, countries=['CU'])
]
In [3]: iso4217parse.by_symbol('$')
Out[3]: [...] # 35 different currencies
In [4]: [c.alpha3 for c in iso4217parse.by_symbol('$')]
Out[4]:
['ARS', 'AUD', 'BBD', 'BMD', 'BZD', 'SBD', 'BND', 'CAD', 'CVE', 'KYD', 'CLP',
'COP', 'CUP', 'DOP', 'FJD', 'GYD', 'HKD', 'JMD', 'LRD', 'MXN', 'NAD', 'NZD',
'SGD', 'TTD', 'USD', 'UYU', 'TWD', 'CUC', 'ZWL', 'XCD', 'SRD', 'BRL', 'KID',
'NTD', 'TVD']
In [5]: iso4217parse.by_symbol('$', country_code='US')
Out[5]:
[
Currency(alpha3='USD', code_num=840, name='United States dollar',
symbols=['US$', '$', '$', '﹩', 'dollar', 'dollars', 'Dollar', 'Dollars', 'US$', 'US﹩'],
minor=2,
countries=['AS', 'EC', 'GU', 'HT', 'MH', 'MP', 'PR', 'PW', 'SV', 'TC', 'TL', 'UM', 'US'])
]
In [6]: iso4217parse.by_symbol?
Signature: iso4217parse.by_symbol(symbol, country_code=None)
Docstring:
Get list of possible currencies for symbol; filter by country_code
Look for all currencies that use the `symbol`. If there are currencies used
in the country of `country_code`, return only those; otherwise return all
found currencies.
Parameters:
symbol: unicode Currency symbol.
country_code: Optional[unicode] Iso3166 alpha2 country code.
Returns:
List[Currency]: Currency objects for `symbol`; filter by country_code.
```
**by_symbol_match:** Look for currency symbol occurrence in input string:
```python
In [1]: import iso4217parse
In [2]: iso4217parse.by_symbol_match('RD$35.8')
Out[2]:
[
Currency(alpha3='DOP', code_num=214, name='Dominican peso',
symbols=['RD$', '$', '﹩', '$', 'dollar', 'dollars', 'Dollar', 'Dollars', 'RD$', 'RD﹩'],
minor=2, countries=['DO'])
]
In [3]: iso4217parse.by_symbol_match('The price is ₨ 35.8 !')
Out[3]:
[
Currency(alpha3='LKR', code_num=144, name='Sri Lankan rupee',
symbols=['රු', '₨', 'Rs', 'ரூ', 'SLRs', 'rupees', 'rupee'],
minor=2, countries=['LK']),
Currency(alpha3='MUR', code_num=480, name='Mauritian rupee',
symbols=['₨', 'rupees', 'rupee'], minor=2, countries=['MU']),
Currency(alpha3='NPR', code_num=524, name='Nepalese rupee',
symbols=['रु', '₨', 'Rs', 'Re', 'rupees', 'rupee'], minor=2, countries=['NP']),
Currency(alpha3='PKR', code_num=586, name='Pakistani rupee',
symbols=['₨', 'Rs', 'rupees', 'rupee'],
minor=2, countries=['PK'])
]
In [4]: iso4217parse.by_symbol_match('The price is ₨ 35.8 !', country_code='NP')
Out[4]:
[
Currency(alpha3='NPR', code_num=524, name='Nepalese rupee',
symbols=['रु', '₨', 'Rs', 'Re', 'rupees', 'rupee'],
minor=2, countries=['NP'])
]
In [5]: iso4217parse.by_symbol_match?
Signature: iso4217parse.by_symbol_match(value, country_code=None)
Docstring:
Get list of possible currencies where the symbol is in value; filter by country_code (iso3166 alpha2 code)
Look for first matching currency symbol in `value`. Filter similar to `by_symbol`.
Symbols are sorted by length and relevance of first character (see `_symbols()`).
Note: This is a [heuristic](https://en.wikipedia.org/wiki/Heuristic) !
Parameters:
value: unicode Some input string.
country_code: Optional[unicode] Iso3166 alpha2 country code.
Returns:
List[Currency]: Currency objects found in `value`; filter by country_code.
```
## Data acquisition
Basic ISO4217 currency information is gathered from Wikipedia: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) . The tables are parsed with `gen_data.py` and stored in `iso4217parse/data.json`. This gives information for `alpha3`, `code_num`, `name`, `minor` and `countries`. The currency symbol information is hand gathered from:
- individual Wikipedia pages, i.e. [EUR](https://en.wikipedia.org/wiki/Euro) has a `Denominations` -> `Symbol` section.
- [http://www.iotafinance.com/en/ISO-4217-Currency-Codes.html](http://www.iotafinance.com/en/ISO-4217-Currency-Codes.html)
- [http://www.xe.com/currency/](http://www.xe.com/currency/) , i.e. [GBP](http://www.xe.com/currency/gbp-british-pound) has a `Currency Facts` -> `Symbol` section
and stored in `iso4217parse/symbols.json`. Each currency can have multiple currency symbols - the first symbol in the list is the (opinionated) choice
for the currency.
## Contribution
If you want to contribute, here are some ways you can help:
- hand check symbols for currency code.
- automatic generation of the `iso4217parse/symbols.json` file
To setup the project for local development, be sure to use [poetry](https://python-poetry.org/) for the installation of the dependencies:
```sh
# install dependencies
> poetry install
# perform formatting
> make fmt
# check style
> make check
# run tests
> make test
```
Raw data
{
"_id": null,
"home_page": "https://github.com/tammoippen/iso4217parse",
"name": "iso4217parse",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "iso4217, currency, parse, symbol",
"author": "Tammo Ippen",
"author_email": "tammo.ippen@posteo.de",
"download_url": "https://files.pythonhosted.org/packages/78/28/49f0e3b073d1d53b5f0a1139ac90bb2794e1081c1fe99a0ce8681fff7454/iso4217parse-0.6.0.tar.gz",
"platform": null,
"description": "[![CI](https://github.com/tammoippen/iso4217parse/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/tammoippen/iso4217parse/actions/workflows/CI.yml)\n[![Coverage Status](https://coveralls.io/repos/github/tammoippen/iso4217parse/badge.svg?branch=master)](https://coveralls.io/github/tammoippen/iso4217parse?branch=master)\n[![Tested CPython Versions](https://img.shields.io/badge/cpython-3.9%2C%203.10%2C%203.11%2C%203.12%2C%203.13-brightgreen.svg)](https://img.shields.io/badge/cpython-3.9%2C%203.10%2C%203.11%2C%203.12%2C%203.13-brightgreen.svg)\n[![Tested PyPy Versions](https://img.shields.io/badge/pypy-3.9%2C%203.10-brightgreen.svg)](https://img.shields.io/badge/pypy-3.9%2C%203.10%2C%203.10-brightgreen.svg)\n[![PyPi version](https://img.shields.io/pypi/v/iso4217parse.svg)](https://pypi.python.org/pypi/iso4217parse)\n[![PyPi license](https://img.shields.io/pypi/l/iso4217parse.svg)](https://pypi.python.org/pypi/iso4217parse)\n\n# ISO4217 Currency Parser\n\nParse currencies (symbols and codes) from and to [ISO4217](https://en.wikipedia.org/wiki/ISO_4217).\n\nSimilar to [iso4217](https://github.com/spoqa/iso4217) package, but\n\n- data is acquired by scraping Wikipedia (see [below](#data-acquisition)) - this is repeatable and you stay on the most current data\n- currency symbols are curated by hand - this allows some fuzzy currency matching\n- no download and parsing during install\n- no external dependencies (`enum34`)\n\nWhen you want to _reuse_ the [_data.json_](https://github.com/tammoippen/iso4217parse/blob/master/iso4217parse/data.json) file for your projects, please leave a attribution note. I license the file under (CC BY 4.0).\n\nInstall:\n\n```sh\npip install iso4217parse\n```\n\n**(If you are required to use python version 2.7 or lower than 3.9, please use version [0.5.1](https://pypi.org/project/iso4217parse/0.5.1/))**\n\n## Documentation\n\nEach currency is modeled as a `collections.namedtuple`:\n\n```python\nCurrency = namedtuple('Currency', [\n 'alpha3', # unicode: the ISO4217 alpha3 code\n 'code_num', # int: the ISO4217 numeric code\n 'name', # unicode: the currency name\n 'symbols', # List[unicode]: list of possible symbols;\n # first is opinionated choice for representation\n 'minor', # int: number of decimal digits to round\n 'countries', # List[unicode]: list of countries that use this currency.\n])\n```\n\n**parse:** Try to parse the input in a best effort approach by using `by_alpha3()`, `by_code_num()`, ... functions:\n\n```python\nIn [1]: import iso4217parse\n\nIn [2]: iso4217parse.parse('CHF')\nOut[2]: [Currency(alpha3='CHF', code_num=756, name='Swiss franc',\n symbols=['SFr.', 'fr', 'Fr.', 'F', 'franc', 'francs', 'Franc', 'Francs'],\n minor=2, countries=['CH', 'LI'])]\n\nIn [3]: iso4217parse.parse(192)\nOut[3]:\n[Currency(alpha3='CUP', code_num=192, name='Cuban peso',\n symbols=['\u20b1', '\uff04', '\ufe69', '$', 'dollar', 'dollars', 'Dollar', 'Dollars', '\uff04MN', '\ufe69MN', '$MN'],\n minor=2, countries=['CU'])]\n\nIn [4]: iso4217parse.parse('Price is 5 \u20ac')\nOut[4]: [Currency(alpha3='EUR', code_num=978, name='Euro',\n symbols=['\u20ac', 'euro', 'euros'], minor=2,\n countries=['AD', 'AT', 'AX', 'BE', 'BL', 'CY', 'DE', 'EE', 'ES', 'FI',\n 'FR', 'GF', 'GP', 'GR', 'IE', 'IT', 'LT', 'LU', 'LV', 'MC',\n 'ME', 'MF', 'MQ', 'MT', 'NL', 'PM', 'PT', 'RE', 'SI', 'SK',\n 'SM', 'TF', 'VA', 'XK', 'YT'])]\n\nIn [5]: iso4217parse.parse('CA\ufe6915.76')\nOut[5]: [Currency(alpha3='CAD', code_num=124, name='Canadian dollar',\n symbols=['CA$', 'CA\uff04', '\uff04', '$', 'dollar', 'dollars', 'Dollar', 'Dollars', 'CA\ufe69', '\ufe69'],\n minor=2, countries=['CA'])]\n\nIn [6]: iso4217parse.parse?\nSignature: iso4217parse.parse(v, country_code=None)\nDocstring:\nTry parse `v` to currencies; filter by country_code\n\nIf `v` is a number, try `by_code_num()`; otherwise try:\n 1) if `v` is 3 character uppercase: `by_alpha3()`\n 2) Exact symbol match: `by_symbol()`\n 3) Exact country code match: `by_country()`\n 4) Fuzzy by symbol match heuristic: `by_symbol_match()`\n\nParameters:\n v: Union[unicode, int] Either a iso4217 numeric code or some string\n country_code: Optional[unicode] Iso3166 alpha2 country code.\n\nReturns:\n List[Currency]: found Currency objects.\n```\n\n**by_alpha3:** Get the currency by its iso4217 alpha3 code:\n\n```python\nIn [1]: import iso4217parse\n\nIn [2]: iso4217parse.by_alpha3('CHF')\nOut[2]: Currency(alpha3='CHF', code_num=756, name='Swiss franc',\n symbols=['SFr.', 'fr', 'Fr.', 'F', 'franc', 'francs', 'Franc', 'Francs'],\n minor=2, countries=['CH', 'LI'])\n\nIn [3]: iso4217parse.by_alpha3?\nSignature: iso4217parse.by_alpha3(code)\nDocstring:\nGet Currency for ISO4217 alpha3 code\n\nParameters:\n code: unicode An alpha3 iso4217 code.\n\nReturns:\n Currency: Currency object for `code`, if available.\n```\n\n**by_code_num:** Get the currency by its iso4217 numeric code:\n\n```python\nIn [1]: import iso4217parse\n\nIn [2]: iso4217parse.by_code_num(51)\nOut[2]: Currency(alpha3='AMD', code_num=51, name='Armenian dram',\n symbols=['\u058f', '\u0564\u0580', 'dram'], minor=2, countries=['AM'])\n\nIn [3]: iso4217parse.by_code_num?\nSignature: iso4217parse.by_code_num(code_num)\nDocstring:\nGet Currency for ISO4217 numeric code\n\nParameters:\n code_num: int An iso4217 numeric code.\n\nReturns:\n Currency: Currency object for `code_num`, if available.\n```\n\n**by_country:** Get currencies used in a country:\n\n```python\nIn [1]: import iso4217parse\n\nIn [2]: iso4217parse.country('HK')\nOut[2]:\n[\n Currency(alpha3='HKD', code_num=344, name='Hong Kong dollar',\n symbols=['HK$', 'HK\uff04', '\uff04', '$', 'dollar', 'dollars', 'Dollar', 'Dollars', 'HK\ufe69', '\ufe69', '\u5143'],\n minor=2, countries=['HK']),\n Currency(alpha3='CNH', code_num=None, name='Chinese yuan (when traded offshore)',\n symbols=['CN\u00a5', '\uffe5', 'CN\uffe5', '\u00a5', 'RMB', '\u5143'],\n minor=2, countries=['HK'])\n]\n\nIn [3]: iso4217parse.country?\nSignature: iso4217parse.by_country(country_code)\nDocstring:\nGet all currencies used in country\n\nParameters:\n country_code: unicode iso3166 alpha2 country code\n\nReturns:\n List[Currency]: Currency objects used in country.\n```\n\n**by_symbol:** Get currencies that use the given symbol:\n\n```python\nIn [1]: import iso4217parse\n\nIn [2]: iso4217parse.by_symbol('\uff04MN')\nOut[2]:\n[\n Currency(alpha3='CUP', code_num=192, name='Cuban peso',\n symbols=['\u20b1', '\uff04', '\ufe69', '$', 'dollar', 'dollars', 'Dollar', 'Dollars', '\uff04MN', '\ufe69MN', '$MN'],\n minor=2, countries=['CU'])\n]\n\nIn [3]: iso4217parse.by_symbol('\uff04')\nOut[3]: [...] # 35 different currencies\n\nIn [4]: [c.alpha3 for c in iso4217parse.by_symbol('\uff04')]\nOut[4]:\n['ARS', 'AUD', 'BBD', 'BMD', 'BZD', 'SBD', 'BND', 'CAD', 'CVE', 'KYD', 'CLP',\n 'COP', 'CUP', 'DOP', 'FJD', 'GYD', 'HKD', 'JMD', 'LRD', 'MXN', 'NAD', 'NZD',\n 'SGD', 'TTD', 'USD', 'UYU', 'TWD', 'CUC', 'ZWL', 'XCD', 'SRD', 'BRL', 'KID',\n 'NTD', 'TVD']\n\nIn [5]: iso4217parse.by_symbol('\uff04', country_code='US')\nOut[5]:\n[\n Currency(alpha3='USD', code_num=840, name='United States dollar',\n symbols=['US$', '$', '\uff04', '\ufe69', 'dollar', 'dollars', 'Dollar', 'Dollars', 'US\uff04', 'US\ufe69'],\n minor=2,\n countries=['AS', 'EC', 'GU', 'HT', 'MH', 'MP', 'PR', 'PW', 'SV', 'TC', 'TL', 'UM', 'US'])\n]\n\nIn [6]: iso4217parse.by_symbol?\nSignature: iso4217parse.by_symbol(symbol, country_code=None)\nDocstring:\nGet list of possible currencies for symbol; filter by country_code\n\nLook for all currencies that use the `symbol`. If there are currencies used\nin the country of `country_code`, return only those; otherwise return all\nfound currencies.\n\nParameters:\n symbol: unicode Currency symbol.\n country_code: Optional[unicode] Iso3166 alpha2 country code.\n\nReturns:\n List[Currency]: Currency objects for `symbol`; filter by country_code.\n```\n\n**by_symbol_match:** Look for currency symbol occurrence in input string:\n\n```python\nIn [1]: import iso4217parse\n\nIn [2]: iso4217parse.by_symbol_match('RD$35.8')\nOut[2]:\n[\n Currency(alpha3='DOP', code_num=214, name='Dominican peso',\n symbols=['RD$', '\uff04', '\ufe69', '$', 'dollar', 'dollars', 'Dollar', 'Dollars', 'RD\uff04', 'RD\ufe69'],\n minor=2, countries=['DO'])\n]\n\nIn [3]: iso4217parse.by_symbol_match('The price is \u20a8 35.8 !')\nOut[3]:\n[\n Currency(alpha3='LKR', code_num=144, name='Sri Lankan rupee',\n symbols=['\u0dbb\u0dd4', '\u20a8', 'Rs', '\u0bb0\u0bc2', 'SLRs', 'rupees', 'rupee'],\n minor=2, countries=['LK']),\n Currency(alpha3='MUR', code_num=480, name='Mauritian rupee',\n symbols=['\u20a8', 'rupees', 'rupee'], minor=2, countries=['MU']),\n Currency(alpha3='NPR', code_num=524, name='Nepalese rupee',\n symbols=['\u0930\u0941', '\u20a8', 'Rs', 'Re', 'rupees', 'rupee'], minor=2, countries=['NP']),\n Currency(alpha3='PKR', code_num=586, name='Pakistani rupee',\n symbols=['\u20a8', 'Rs', 'rupees', 'rupee'],\n minor=2, countries=['PK'])\n]\n\nIn [4]: iso4217parse.by_symbol_match('The price is \u20a8 35.8 !', country_code='NP')\nOut[4]:\n[\n Currency(alpha3='NPR', code_num=524, name='Nepalese rupee',\n symbols=['\u0930\u0941', '\u20a8', 'Rs', 'Re', 'rupees', 'rupee'],\n minor=2, countries=['NP'])\n]\n\nIn [5]: iso4217parse.by_symbol_match?\nSignature: iso4217parse.by_symbol_match(value, country_code=None)\nDocstring:\nGet list of possible currencies where the symbol is in value; filter by country_code (iso3166 alpha2 code)\n\nLook for first matching currency symbol in `value`. Filter similar to `by_symbol`.\nSymbols are sorted by length and relevance of first character (see `_symbols()`).\n\nNote: This is a [heuristic](https://en.wikipedia.org/wiki/Heuristic) !\n\nParameters:\n value: unicode Some input string.\n country_code: Optional[unicode] Iso3166 alpha2 country code.\n\nReturns:\n List[Currency]: Currency objects found in `value`; filter by country_code.\n```\n\n## Data acquisition\n\nBasic ISO4217 currency information is gathered from Wikipedia: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) . The tables are parsed with `gen_data.py` and stored in `iso4217parse/data.json`. This gives information for `alpha3`, `code_num`, `name`, `minor` and `countries`. The currency symbol information is hand gathered from:\n\n- individual Wikipedia pages, i.e. [EUR](https://en.wikipedia.org/wiki/Euro) has a `Denominations` -> `Symbol` section.\n- [http://www.iotafinance.com/en/ISO-4217-Currency-Codes.html](http://www.iotafinance.com/en/ISO-4217-Currency-Codes.html)\n- [http://www.xe.com/currency/](http://www.xe.com/currency/) , i.e. [GBP](http://www.xe.com/currency/gbp-british-pound) has a `Currency Facts` -> `Symbol` section\n\nand stored in `iso4217parse/symbols.json`. Each currency can have multiple currency symbols - the first symbol in the list is the (opinionated) choice\nfor the currency.\n\n## Contribution\n\nIf you want to contribute, here are some ways you can help:\n\n- hand check symbols for currency code.\n- automatic generation of the `iso4217parse/symbols.json` file\n\nTo setup the project for local development, be sure to use [poetry](https://python-poetry.org/) for the installation of the dependencies:\n\n```sh\n# install dependencies\n> poetry install\n\n# perform formatting\n> make fmt\n\n# check style\n> make check\n\n# run tests\n> make test\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Parse currencies (symbols and codes) from and to ISO4217.",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/tammoippen/iso4217parse",
"Repository": "https://github.com/tammoippen/iso4217parse"
},
"split_keywords": [
"iso4217",
" currency",
" parse",
" symbol"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "782849f0e3b073d1d53b5f0a1139ac90bb2794e1081c1fe99a0ce8681fff7454",
"md5": "99ca3c5c147fdb3cbbcb1c4243e04b94",
"sha256": "c0eedb8edc59a4f1a328b8515311ea68806284c092344bf92ef13018b3ce19bb"
},
"downloads": -1,
"filename": "iso4217parse-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "99ca3c5c147fdb3cbbcb1c4243e04b94",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 22581,
"upload_time": "2024-11-07T08:39:08",
"upload_time_iso_8601": "2024-11-07T08:39:08.752041Z",
"url": "https://files.pythonhosted.org/packages/78/28/49f0e3b073d1d53b5f0a1139ac90bb2794e1081c1fe99a0ce8681fff7454/iso4217parse-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-07 08:39:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tammoippen",
"github_project": "iso4217parse",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "iso4217parse"
}