Metadata-Version: 2.1
Name: pyptax
Version: 0.1.0
Summary: A Python library to retrieve information of PTAX rates
Home-page: https://github.com/brunobcardoso/pyptax
Author: Bruno Cardoso
Author-email: cardosobrunob@gmail.com
License: MIT
Keywords: ptax
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Office/Business :: Financial
Description-Content-Type: text/markdown
Requires-Dist: requests (>=2.0)
Provides-Extra: dev
Requires-Dist: coverage ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: responses ; extra == 'dev'

# PyPtax

PyPtax is a Python library to retrieve information on
[Ptax rates](https://www.bcb.gov.br/conteudo/relatorioinflacao/EstudosEspeciais/EE042_A_taxa_de_cambio_de_referencia_Ptax.pdf).

## What is Ptax?

Ptax exchange rate is the reference exchange rate for U.S. Dollar, expressed as the amount of Brazilian Reais per one U.S. Dollar,
published by the [Central Bank of Brazil](https://www.bcb.gov.br/en).

## Installation
```bash
$ pip install pyptax
```

## Usage

### Get closing rates on a certain date

```python
>>> from pyptax import ptax

>>> close = ptax.close('01-17-2020')
>>> print(close)
{
    'datetime': '2020-01-17 13:09:30.096',
    'bid': '4.1831',
    'ask': '4.1837',
}
```


