pyptax 0.5.0

A Python library to retrieve information on Ptax rates

PyPtax

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

Features | Installation | Quickstart | 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.

Features

• Closing Ptax rates for a requested date
• Historical Ptax rates for a requested period
• Intermediary Ptax rates for a requested date

Installation

$ pip install pyptax

Quickstart

Closing Ptax rates for a requested date

Command line:

$ pyptax close --date 2020-01-20

Module:

>>> from pyptax import ptax
>>> bulletin = ptax.close("2020-01-20")
>>> bulletin.as_dict
{
    "datetime": "2020-01-20 13:09:02.871",
    "bid": 4.1823,
    "ask": 4.1829,
    "bulletin_type":
    "close"
}
>>> bulletin.datetime
"2020-01-20 13:09:02.871"
>>> bulletin.bid
4.1823
>>> bulletin.ask
4.1829

Historical Ptax rates for a requested period

Command line:

$ pyptax historical --start_date 2020-01-01 --end_date 2020-01-05

Module:

>>> from pyptax import ptax
>>> historical_bulletin = ptax.historical('2020-01-01', '2020-01-05')
>>> historical_bulletin
HistoricalBulletin(
    start_date="2020-01-01",
    end_date="2020-01-03",
    bulletins=[
        Bulletin("2020-01-02 13:11:10.762", 4.0207, 4.0213, "close"),
        Bulletin("2020-01-03 13:06:22.606", 4.0516, 4.0522, "close"),
    ],
)

>>> historical_bulletin.as_dict
{
    "start_date": "2020-01-01",
    "end_date": "2020-01-03",
    "bulletins": [
        {
            "datetime": "2020-01-02 13:11:10.762",
            "bid": 4.0207,
            "ask": 4.0213,
            "bulletin_type": "close"
        },
        {
            "datetime": "2020-01-03 13:06:22.606",
            "bid": 4.0516,
            "ask": 4.0522,
            "bulletin_type": "close"
        },
    ],
}

:warning: Enter all dates in the format YYYY-MM-DD

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.