Metadata-Version: 2.1
Name: pyrrencies
Version: 0.1.0
Summary: Comfortable work with currencies and currencies exchange rates
Home-page: https://github.com/de-jure/pyrrencies
Author: Yurii Plets
Author-email: de.jure.software@gmail.com
License: MIT
Keywords: currency currencies exchange rates
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE.md

# Pyrrencies Python Library

## Overview

The `pyrrencies` library provides a convenient way to handle currency conversion and arithmetic operations in Python. It supports a wide range of currencies and allows for easy conversion between them.

## Installation

```bash
pip install pyrrencies
```

## Usage

### Initialization

```python
from pyrrencies import CurrencyAmount

amount_usd = CurrencyAmount(1000, 'USD')   # USD 10.0
amount_uah = CurrencyAmount(10000, 'UAH')  # UAH 100.0
```

### Display

```python
print(amount_usd)  # USD 10.0
```

### Accessing Properties

```python
print(amount_usd.cents)     # 1000
print(amount_usd.currency)  # USD
```

### Currency Conversion

```python
print(amount_usd.to('UAH'))  # UAH 367.44
print(amount_usd.to('EUR'))  # EUR 9.55
```

### Exchange Rates

```python
from pyrrencies import CurrencyRates

print(CurrencyRates.get_rate('USD', 'UAH'))  # 36.744452
print(CurrencyRates.get_rate('PLN', 'EUR'))  # 0.21633
```

### Arithmetic Operations

```python
print(amount_usd + 50)                    # USD 10.5
print(amount_usd + amount_uah)            # ValueError: Currencies must be the same
print(amount_usd + amount_uah.to('USD'))  # USD 12.72
print(amount_usd - amount_uah.to('USD'))  # USD 7.28
print(amount_usd * 7.34)                  # USD 73.4
print(amount_usd / 2)                     # USD 5.0
```

### Comparison

```python
print(amount_usd == amount_uah)  # False
print(amount_usd != amount_uah)  # True
print(amount_usd > amount_uah)   # ValueError: Currencies must be the same
print(amount_usd >= amount_uah)  # ValueError: Currencies must be the same
print(amount_usd < amount_uah)   # ValueError: Currencies must be the same
print(amount_usd <= amount_uah)  # ValueError: Currencies must be the same
```

### Supported Currencies

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, FOK, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TVD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMW, ZWL


