Skip to main content

A simple package to deflate BR currency values using IPCA's historical yearly and monthly indexes

Project description

Python brazilian currency deflator

A simple python package to deflate historical yearly or monthly values using IPCA (Consumers Broad Price Index).

Throught IPEA Data's API the function gather historical IPCA yearly (PRECOS_IPCAG series) and monthly (PRECOS12_IPCAG12 series) indexes to deflate currency values.

Installation:

  • pandas and requests packages are required in your environment (python -m pip install pandas requests).
  • Install the package (pip install deflatepybr)

Usage:

The function takes 5 arguments:

  • data_frame: A Pandas.DataFrame with the data;
  • value_column(str): A column containing the values to deflate;
  • date_column(str): Column name from data_frame with the date range;
  • deflate_year(int): Year that you wanna deflate the series to;
  • deflate_month(int), optional: Month to deflate if you need monthly index values.

If only deflate_year is passed, the functions assumes that Yearly values are desired.

Examples can be found in the example.ipynb jupyter notebook file available on the project's Github page.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

deflatepybr-0.0.8.tar.gz (3.2 kB view hashes)

Uploaded Source

Built Distribution

deflatepybr-0.0.8-py3-none-any.whl (4.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page