PyPtax

PyPtax is a Python library and CLI to retrieve information on Ptax rates

Installation | Usage | Documentation | Contributing

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.

Installation

$ pip install pyptax

Quickstart

Get closing rates on a certain date

Command line:

$ pyptax close --date 2020-01-20

Module:

>>> from pyptax import ptax
>>> close_report = ptax.close('2020-01-20')
>>> close_report.as_dict
{'datetime': '2020-01-20 13:09:02.871', 'bid': '4.1823', 'ask': '4.1829'}
>>> close_report.datetime
'2020-01-20 13:09:02.871'
>>> close_report.bid
'4.1823'
>>> close_report.ask
'4.1829'
>>> print(close_report.display())
+----------+-------------------------+
| datetime | 2020-01-20 13:09:02.871 |
| bid      | 4.1823                  |
| ask      | 4.1829                  |
+----------+-------------------------+

Documentation

The full documentation is available on https://pyptax.readthedocs.io/.

Contributing

Please see the contributing page for guidance on setting up a development environment and how to contribute.