pydeflate 1.4.1__py3-none-any.whl → 2.0.0__py3-none-any.whl

pydeflate-1.4.1.dist-info/METADATA

@@ -1,305 +0,0 @@
-Metadata-Version: 2.1
-Name: pydeflate
-Version: 1.4.1
-Summary: Package to convert current prices figures to constant prices and vice versa
-License: MIT
-Author: Jorge Rivera
-Author-email: jorge.rivera@one.org
-Requires-Python: >=3.10,<4.0
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: End Users/Desktop
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: bblocks (>=1.3,<2.0)
-Requires-Dist: country-converter (>=1,<2)
-Requires-Dist: numpy (>=1.26,<2.0)
-Requires-Dist: oda-reader (>=0.2.1,<0.3.0)
-Requires-Dist: pandas (>=2,<3)
-Requires-Dist: pyarrow (>=15.0,<17.0)
-Requires-Dist: requests (>=2.28.2,<3.0.0)
-Requires-Dist: xlrd (>=2.0.1,<3.0.0)
-Description-Content-Type: text/markdown
-
-# pydeflate
-
-[![pypi](https://img.shields.io/pypi/v/pydeflate.svg)](https://pypi.python.org/pypi/pydeflate)
-[![Documentation Status](https://readthedocs.org/projects/pydeflate/badge/?version=latest)](https://pydeflate.readthedocs.io/en/latest/?version=latest)
-[![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Downloads](https://pepy.tech/badge/pydeflate/month)](https://pepy.tech/project/pydeflate)
-[![Coverage](https://codecov.io/gh/jm-rivera/pydeflate/branch/main/graph/badge.svg?token=uwKI5DyO3w)](https://codecov.io/gh/jm-rivera/pydeflate)
-
-**pydeflate** is a Python package to convert flows data to constant
-prices. This can be done from any source currency to any desired base
-year and currency. **Pydeflate** can also be used to convert constant
-data to current prices and to convert from one currency to another (in
-current and constant prices). Users can choose the source of the
-exchange and deflator/prices data (currently, IMF, World Bank or OECD
-DAC).
-
-## Getting started
-
-### Installation
-
-pydeflate can be installed from PyPI. From the command line:
-
-```bash
-
-pip install pydeflate
-
-```
-
-## Basic usage
-
-### Current to constant
-
-Convert data expressed in current USD prices to constant EUR prices for
-a given base year:
-
-```python
-from pydeflate import deflate, set_pydeflate_path
-import pandas as pd
-
-# Specify where the deflator and exchange data should be saved
-set_pydeflate_path("path/to/data/folder")
-
-# example data
-data = {
-    'iso_code': ['FRA', 'USA', 'GTM'],
-    'year': [2017, 2017, 2017],
-    'value': [50, 100, 200]
-}
-
-# create an example dataframe, in current USD prices
-df = pd.DataFrame.from_dict(data)
-
-# convert to EUR 2015 constant prices
-df_constant = deflate(
-    df=df,
-    base_year=2015,
-    deflator_source='world_bank',
-    deflator_method='gdp',
-    exchange_source="world_bank",
-    source_currency="USA",  # since data is in USD
-    target_currency="EMU",  # we want the result in constant EUR
-    id_column="iso_code",
-    id_type="ISO3",  # specifying this is optional in most cases
-    date_column="year",
-    source_column="value", # where the original data is
-    target_col="value_constant", # where the new data will be stored
-)
-```
-
-This results in a dataframe containing a new column `value_constant` in
-2015 constant prices. In the background, pydeflate takes into account:
-
-- changes in princes, through a gdp deflator in this case
-- changes in exchange rates overtime
-
-### Current Local Currency Units to constant in a different currency
-Pydeflate can also handle data that is expressed in local currency
-units. In that case, users can specify `LCU` as the source currency.
-
-```python
-from pydeflate import deflate, set_pydeflate_path
-import pandas as pd
-
-# Specify where the deflator and exchange data should be saved
-set_pydeflate_path("path/to/data/folder")
-
-# example data
-data = {
-    'country': ['United Kingdom', 'United Kingdom', 'Japan'],
-    'date': [2011, 2015, 2015],
-    'value': [100, 100, 100]
-}
-
-# create an example dataframe, in current local currency units
-df = pd.DataFrame.from_dict(data)
-
-# convert to USD 2018 constant prices
-df_constant = deflate(
-    df=df,
-    base_year=2018,
-    deflator_source='imf',
-    deflator_method='pcpi',
-    exchange_source="imf",
-    source_currency="LCU",  # since data is in LCU
-    target_currency="USA",  # to get data in USD
-    id_column="iso_code",
-    date_column="date",
-    source_col="value",
-    target_col="value",  # to not create a new column
-)
-
-```
-
-### Constant to current
-Users can also convert a dataset expressed in constant prices to current
-prices using pydeflate. To avoid introducing errors, users should know
-which methodology/ data was used to create constant prices by the
-original source. The basic usage is the same as before, but the
-`to_current` parameter is set to `True`.
-
-For example, to convert DAC data expressed in 2016 USD constant prices
-to current US dollars:
-
-```python
-from pydeflate import deflate, set_pydeflate_path
-import pandas as pd
-
-# Specify where the deflator and exchange data should be saved
-set_pydeflate_path("path/to/data/folder")
-
-# example data
-data = {
-    'dac_code': [302, 4, 4],
-    'date': [2010, 2016, 2018],
-    'value': [100, 100, 100]
-}
-
-# create an example dataframe, in current local currency units
-df = pd.DataFrame.from_dict(data)
-
-# convert to USD 2018 constant prices
-df_current = deflate(
-    df=df,
-    base_year=2016,
-    deflator_source='oecd_dac',
-    deflator_method='dac_deflator',
-    exchange_source="oecd_dac",
-    source_currency="USA",  # since data is in USD constant
-    target_currency="LCU",  # to get the current LCU figures
-    id_column="dac_code",
-    id_type="DAC",
-    date_column="date",
-    source_column="value",
-    target_column="value_current",
-    to_current=True,
-)
-```
-
-## Data source and method options
-
-In order to convert the data, pydeflate uses data on **price/gdp deflators** and
-**exchange rates**. Each of these data sources can come from the `OECD DAC`,
-`IMF (WEO)` or `World Bank`.
-
-For all sources, Exchange rates between two non USD currency pairs are derived from
-the LCU to USD exchange rates selected.
-
-### International Monetary Fund World Economic Outlook ("imf")
-
-For price/gdp deflators from the IMF, the following options are available (`deflator_method`):
-- `gdp`: in order to use GDP deflators.
-- `pcpi`: in order to use Consumer Price Index data.
-- `pcpie`: to use end-of-period Consumer Price Index data
-  (e.g. for December each year).
-
-The IMF provides estimates where data is not available, including for several
-years into the future. Using these price deflators, combined with the corresponding
-exchange rates, allows users to convert data to constant prices for future years.
-
-For exchange rates, the following options are available from the imf (`exchange_method`):
-- `implied`: to use the exchange rates used by the World Economic Outlook, derived from
-    the WEOs data on GDP in US Dollars and Local Currency Units.
-
-### World Bank ("world_bank")
-
-For price/gdp deflators from the World Bank, the following options are available (`deflator_method`):
-
-
-In terms of price or GDP deflators, pydeflate provides the following
-- `gdp`: in order to use GDP deflators.
-- `gdp_linked`: to use the World Bank's GDP deflator series which
-  has been linked to produce a consistent time series to
-  counteract breaks in series over time due to changes in base
-  years, sources or methodologies.
-- `cpi`: to use Consumer Price Index data
-
-For exchange rates, the following options are available from the World Bank (`exchange_method`):
-- `yearly_average`: as used by the World Bank, based on IMF International Financial Statistics data.
-
-
-### OECD Development Assistance Committee ("oecd_dac")
-
-For price/gdp deflators from the OECD DAC, the following options are available (`deflator_method`):
-
-In terms of price or GDP deflators, pydeflate provides the following:
-- `dac_deflator`: in order to use the DAC's own deflator series.
-
-For exchange rates, the following options are available from the OECD DAC (`exchange_method`):
-- `implied`: to use the exchange rates used and published by the DAC.
-
-
-
-## Additional features
-
-Pydeflate relies on data from the World Bank, IMF and OECD for its
-calculations. This data is updated periodically. If the version of the
-data stored in the user's computer is older than 50 days, pydeflate will
-show a warning on import.
-
-Users can always update the underlying data by using:
-
-```python
-import pydeflate
-
-pydeflate.update_all_data()
-
-```
-
-Pydeflate also provides users with a tool to exchange figures from one
-currency to another, without applying any deflators. This should only be
-used on numbers expressed in current prices, however.
-
-For example, to convert numbers in current Local Currency Units (LCU) to
-current Canadian Dollars:
-
-```python
-import pydeflate
-import pandas as pd
-
-# example data
-data = {
-    'iso_code': ['GBR', 'CAN', 'JPN'],
-    'date': [2011, 2015, 2015],
-    'value': [100, 100, 100]
-}
-
-# create an example dataframe, in current local currency units
-df = pd.DataFrame.from_dict(data)
-
-# convert to USD 2018 constant prices
-df_can = pydeflate.exchange(
-    df=df,
-    source_currency="LCU",  # since data is in LCU
-    target_currency="CAN",  # to get data in Canadian Dollars
-    rates_source='imf', 
-    value_column='value',
-    target_column='value_CAN',
-    id_column="iso_code",
-    id_type="ISO3",
-    date_column="date",
-)
-
-```
-
-### Credits
-
-This package relies on data from the following sources:
-
-- OECD DAC: <https://www.oecd.org/dac/> (Official Development
-  assistance data (DAC1), DAC deflators, and exchange rates used by
-  the DAC)
-- IMF World Economic Outlook:
-  <https://www.imf.org/en/Publications/WEO> (GDP and price deflators)
-- World Bank DataBank: <https://databank.worldbank.org/home.aspx>
-  (exchange rates, GDP and price deflators)
-
-This data is provided based on the terms and conditions set by the
-original sources.

pydeflate-1.4.1.dist-info/RECORD

@@ -1,22 +0,0 @@
-pydeflate/.pydeflate_data/README.md,sha256=atNtUL9dD8G184YSd6juFib8TgEQBcSLogiz99APPVs,25
-pydeflate/__init__.py,sha256=08ORceoaZwtQCmYO1Og1NtRFNeGP-VEwh7xG5k61cI0,817
-pydeflate/deflate/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pydeflate/deflate/deflate.py,sha256=hSlhuJi1YsemvvRBFgJog1oQI8lqkJ8nBn6PoufR7uk,11850
-pydeflate/deflate/deflator.py,sha256=8nX_E1WPfY1ej8lfoLyOxnWNX0kW9khQIxa_QlrRm4A,2684
-pydeflate/get_data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pydeflate/get_data/deflate_data.py,sha256=tZuxT38xRBXXaPSpLFtrEL5iz2TO7LFs8lNG2E64Ew0,2285
-pydeflate/get_data/exchange_data.py,sha256=bXMiYlHxqKqyZvkKhogFXOXVCmDL-rF6TNraVd3daNA,12248
-pydeflate/get_data/imf_data.py,sha256=mEeqC1DfZ8kPn6fUjaFVNX8VfuSHtARcrqBVLnxwrRs,2693
-pydeflate/get_data/oecd_data.py,sha256=QMHpCjpedlzoWpHaMk64vVIzuoAiJ99gXf0l1siLR3I,4492
-pydeflate/get_data/wb_data.py,sha256=21L1ALmxL0Y-KjoDLJI7EUsDt8igBRnDjCro4lKi0l0,2103
-pydeflate/pydeflate_config.py,sha256=wY9RQ2UVmCekusHeKUFmryA1DzWanP9BuOPDFPyva-4,894
-pydeflate/settings/emu.json,sha256=BIvbiMUeHUtCESR3sMcBNrS028yp2YraCJdhDJGvAAo,133
-pydeflate/settings/oecd_codes.json,sha256=jAKI1EgQP4rttjoG3Z-44r1tUJrIEzPCZF5V2aboQhE,911
-pydeflate/tools/__init__.py,sha256=gbUXYeGrcrqcOc70BjFtxHtBnwSqor-SlWYgZjypEOA,47
-pydeflate/tools/exchange.py,sha256=q8E4IsZcI015UjIwLXWl7d9PiqgHTFyalRm2fURfc3Y,5465
-pydeflate/tools/update_data.py,sha256=nB05Y0ZEZ2WcYPjOR_O9QHdvvNy0JkWc1z_sH71U2lY,2109
-pydeflate/utils.py,sha256=p0k3RzJBlqHQGIYWH3woAINRAPpfyM0mRu_cB29QS54,1573
-pydeflate-1.4.1.dist-info/LICENSE,sha256=HwwzYp5BG8nNjP8ZgcxnE-fva8_Yx1ss7PZne73J9IE,1070
-pydeflate-1.4.1.dist-info/METADATA,sha256=XEFzgCKI-ayJl9VdQuqZkyNtJoc6tcSXzoiOTkm9PZU,10030
-pydeflate-1.4.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-pydeflate-1.4.1.dist-info/RECORD,,