1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
|
%global _empty_manifest_terminate_build 0
Name: python-iso4217parse
Version: 0.5.1
Release: 1
Summary: Parse currencies (symbols and codes) from and to ISO4217.
License: MIT
URL: https://github.com/tammoippen/iso4217parse
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/7a/1d/5cfc7d59128bfa843187e93350e3ee98e09758feeea1c3138e1a7111ed0f/iso4217parse-0.5.1.tar.gz
BuildArch: noarch
%description
[](https://circleci.com/gh/tammoippen/iso4217parse)
[](https://coveralls.io/github/tammoippen/iso4217parse?branch=master)
[](https://img.shields.io/badge/cpython-2.7%2C%203.5%2C%203.6%2C%203.7-brightgreen.svg)
[](https://img.shields.io/badge/pypy-2.7--6.0.0%2C%203.5--6.0.0-brightgreen.svg)
[](https://pypi.python.org/pypi/iso4217parse)
[](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 aquired by scraping wikipedia (see [below](#data-aquisition)) - this is repeatable and you stay on the most current data
* currency symbols are currated by hand - this allows some fuzzy currency matching
* no download and parsing during install
* no external dependancies (`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 licence the file under (CC BY 4.0).
Install:
```
pip install iso4217parse
```
## 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 occurence 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 aquisition
Basic ISO4217 currency information is gathered from wikipedia: 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:
* individuel 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.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 Note**: Possible ways to contribute here:
* hand check symbols for currency code.
* automatic generation of the `iso4217parse/symbols.json` file.
%package -n python3-iso4217parse
Summary: Parse currencies (symbols and codes) from and to ISO4217.
Provides: python-iso4217parse
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-iso4217parse
[](https://circleci.com/gh/tammoippen/iso4217parse)
[](https://coveralls.io/github/tammoippen/iso4217parse?branch=master)
[](https://img.shields.io/badge/cpython-2.7%2C%203.5%2C%203.6%2C%203.7-brightgreen.svg)
[](https://img.shields.io/badge/pypy-2.7--6.0.0%2C%203.5--6.0.0-brightgreen.svg)
[](https://pypi.python.org/pypi/iso4217parse)
[](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 aquired by scraping wikipedia (see [below](#data-aquisition)) - this is repeatable and you stay on the most current data
* currency symbols are currated by hand - this allows some fuzzy currency matching
* no download and parsing during install
* no external dependancies (`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 licence the file under (CC BY 4.0).
Install:
```
pip install iso4217parse
```
## 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 occurence 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 aquisition
Basic ISO4217 currency information is gathered from wikipedia: 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:
* individuel 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.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 Note**: Possible ways to contribute here:
* hand check symbols for currency code.
* automatic generation of the `iso4217parse/symbols.json` file.
%package help
Summary: Development documents and examples for iso4217parse
Provides: python3-iso4217parse-doc
%description help
[](https://circleci.com/gh/tammoippen/iso4217parse)
[](https://coveralls.io/github/tammoippen/iso4217parse?branch=master)
[](https://img.shields.io/badge/cpython-2.7%2C%203.5%2C%203.6%2C%203.7-brightgreen.svg)
[](https://img.shields.io/badge/pypy-2.7--6.0.0%2C%203.5--6.0.0-brightgreen.svg)
[](https://pypi.python.org/pypi/iso4217parse)
[](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 aquired by scraping wikipedia (see [below](#data-aquisition)) - this is repeatable and you stay on the most current data
* currency symbols are currated by hand - this allows some fuzzy currency matching
* no download and parsing during install
* no external dependancies (`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 licence the file under (CC BY 4.0).
Install:
```
pip install iso4217parse
```
## 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 occurence 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 aquisition
Basic ISO4217 currency information is gathered from wikipedia: 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:
* individuel 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.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 Note**: Possible ways to contribute here:
* hand check symbols for currency code.
* automatic generation of the `iso4217parse/symbols.json` file.
%prep
%autosetup -n iso4217parse-0.5.1
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-iso4217parse -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 0.5.1-1
- Package Spec generated
|
