pynbpapi 1.0.0__tar.gz

pynbpapi-1.0.0/.github/workflows/flake8-lint.yml

@@ -0,0 +1,26 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  flake8-lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8
+          pip install -r requirements.txt
+
+      - name: Run Flake8
+        run: |
+          flake8 pynbpapi

pynbpapi-1.0.0/.github/workflows/python-tests.yml

@@ -0,0 +1,34 @@
+name: Tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install pytest pytest-cov
+
+      - name: Run tests with coverage
+        run: |
+          pytest --cov=pynbp --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+
+      - name: List files
+        run: ls -la

pynbpapi-1.0.0/.gitignore

@@ -0,0 +1,6 @@
+.venv
+.idea
+**/__pycache__/
+.coverage
+temp.py
+dist/**

pynbpapi-1.0.0/LICENSE

@@ -0,0 +1,17 @@
+MIT License
+Copyright (c) 2026 ARTUR WEGRZYN
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pynbpapi-1.0.0/PKG-INFO

@@ -0,0 +1,197 @@
+Metadata-Version: 2.4
+Name: pynbpapi
+Version: 1.0.0
+Summary: Tidy downloading of National Bank of Poland interest rates, FX rates and gold price data
+Keywords: NBP,FX,PLN,gold,API,REST-API,FX-rates,zloty
+Author-email: Artur Wegrzyn <awegrzyn17@gmail.com>
+Maintainer-email: Artur Wegrzyn <awegrzyn17@gmail.com>
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: requests
+Requires-Dist: python-dateutil
+Requires-Dist: loguru
+
+# pynbpapi
+
+![Flake8 Lint Check](https://github.com/wegar-2/pynbp/actions/workflows/flake8-lint.yml/badge.svg)
+![CI](https://github.com/wegar-2/pynbp/actions/workflows/python-tests.yml/badge.svg)
+[![codecov](https://codecov.io/github/wegar-2/pynbp/graph/badge.svg?token=XJY6OWPSPI)](https://codecov.io/github/wegar-2/pycs)
+
+
+This trivial package provides simple interface (consisting of three functions described below) 
+that allows you to download the selected types of time series made available 
+via [National Bank of Poland's REST API](http://api.nbp.pl/en.html).
+
+
+More specifically, the following time series can be downloaded using PyNBP:
+
+1. Average daily FX rates for select currencies 
+(cf. [NBP's table of daily FX rates against various currencies]() 
+for list of currencies for which exchange rates are published).
+2. Table of historical central bank interest rates.
+3. Gold prices in PLN (note: the gold prices published by NBP are prices of 1g of gold).
+4. Downloading of the daily central bank's [FX rates tables](https://nbp.pl/statystyka-i-sprawozdawczosc/kursy/) (A, B and C)
+
+Note: the table of historical interest is not *per se* provided via NBP's API.
+
+I provide code snippets illustrating how to get the data below.
+
+
+### Import *pynbpapi*
+
+```python
+import pynbpapi
+```
+
+or:
+
+```python
+from pynbpapi import (
+    get_gold_prices, get_interest_rates_table, get_fx_rate,
+    get_nbp_fx_tables, get_fx_rates)
+```
+
+### FX Rate For a Single Pair Against PLN
+To download USDPLN daily average FX rates for the dates range 2018-01-03 to 2021-04-05 
+(these dates are given in the ISO / %Y-%m-%d format) run:
+
+```python
+from pynbpapi import get_fx_rate
+from datetime import date
+
+data = get_fx_rate(ccy="usd", start=date(2018, 1, 3), end=date(2021, 4, 5))
+print(data.head())
+```
+
+Output:
+```
+         date  usdpln_rate
+0  2018-01-03       3.4616
+1  2018-01-04       3.4472
+2  2018-01-05       3.4488
+3  2018-01-08       3.4735
+4  2018-01-09       3.4992
+```
+
+### FX Rates For Multiple Pairs Against PLN
+To download USDPLN, EURPLN and CNYPLN daily average FX rates for the dates 
+range 2018-01-03 to 2021-04-05 
+(these dates are given in the ISO / %Y-%m-%d format)
+in the long format (alternatively - wide format can be chosen) run:
+
+```python
+from pynbpapi import get_fx_rates, Ccy
+from datetime import date
+
+data = get_fx_rates(
+    ccys=[Ccy.EUR, Ccy.USD, Ccy.CNY],
+    start=date(2018, 1, 3),
+    end=date(2021, 4, 5), 
+    fmt="long"
+)
+print(data.head())
+print(data.tail())
+```
+
+Output - head:
+```
+         date    rate    pair
+0  2018-01-03  4.1673  eurpln
+1  2018-01-04  4.1515  eurpln
+2  2018-01-05  4.1544  eurpln
+3  2018-01-08  4.1647  eurpln
+4  2018-01-09  4.1779  eurpln
+```
+And tail:
+```
+           date    rate    pair
+816  2021-03-29  0.6027  cnypln
+817  2021-03-30  0.6030  cnypln
+818  2021-03-31  0.6053  cnypln
+819  2021-04-01  0.5998  cnypln
+820  2021-04-02  0.5941  cnypln
+```
+
+
+
+### Table of Historical Interest Rates
+To download the table of historical interest rates set by NBP run:
+
+```python
+from pynbpapi import get_interest_rates_table
+from datetime import date
+
+data = get_interest_rates_table()
+print(data.tail())
+```
+
+Output:
+```
+   valid_from_date  lombard_rate  reference_rate  rediscount_rate  discount_rate  deposit_rate
+82      2022-04-07        0.0500          0.0450           0.0455         0.0460        0.0400
+83      2022-05-06        0.0575          0.0525           0.0530         0.0535        0.0475
+84      2022-06-09        0.0650          0.0600           0.0605         0.0610        0.0550
+85      2022-07-08        0.0700          0.0650           0.0655         0.0660        0.0600
+86      2022-09-08        0.0725          0.0675           0.0680         0.0685        0.0625
+```
+
+
+
+### Gold Prices in PLN
+To download gold prices in PLN for the dates range 2018-01-03 to 2021-04-05 run:
+
+```python
+from pynbpapi import get_gold_prices
+from datetime import date
+
+data = get_gold_prices(start=date(2018, 1, 3), end=date(2021, 4, 5))
+print(data.head())
+```
+
+Please keep in mind that the daily prices of gold published by 
+NBP are prices of 1g of gold in PLN. 
+
+Output:
+```
+         date  price_of_1g_of_gold_in_pln
+0  2018-01-03                      145.72
+1  2018-01-04                      146.36
+2  2018-01-05                      145.68
+3  2018-01-08                      146.06
+4  2018-01-09                      147.42
+```
+
+
+### Download Daily NBP's FX Rates Tables 
+To download FX rates table A for dates range 2026-02-18 to 2026-02-19 run:
+
+```python
+from pynbpapi import get_nbp_fx_tables
+from datetime import date
+data = get_nbp_fx_tables(table="A", start=date(2026, 2, 18), end=date(2026, 2, 19))
+```
+
+Please keep in mind that the daily prices of gold published by 
+NBP are prices of 1g of gold in PLN. 
+
+Output - head:
+```
+             currency code     mid table              no        date
+0     bat (Tajlandia)  THB  0.1137     A  033/A/NBP/2026  2026-02-18
+1   dolar amerykański  USD  3.5610     A  033/A/NBP/2026  2026-02-18
+2  dolar australijski  AUD  2.5204     A  033/A/NBP/2026  2026-02-18
+3     dolar Hongkongu  HKD  0.4556     A  033/A/NBP/2026  2026-02-18
+4    dolar kanadyjski  CAD  2.6078     A  033/A/NBP/2026  2026-02-18
+```
+
+And tail:
+```
+                   currency code       mid table              no        date
+59       rupia indonezyjska  IDR  0.000212     A  034/A/NBP/2026  2026-02-19
+60           rupia indyjska  INR  0.039242     A  034/A/NBP/2026  2026-02-19
+61  won południowokoreański  KRW  0.002472     A  034/A/NBP/2026  2026-02-19
+62    yuan renminbi (Chiny)  CNY  0.515200     A  034/A/NBP/2026  2026-02-19
+63                SDR (MFW)  XDR  4.909800     A  034/A/NBP/2026  2026-02-19
+```

pynbpapi-1.0.0/README.md

@@ -0,0 +1,182 @@
+# pynbpapi
+
+![Flake8 Lint Check](https://github.com/wegar-2/pynbp/actions/workflows/flake8-lint.yml/badge.svg)
+![CI](https://github.com/wegar-2/pynbp/actions/workflows/python-tests.yml/badge.svg)
+[![codecov](https://codecov.io/github/wegar-2/pynbp/graph/badge.svg?token=XJY6OWPSPI)](https://codecov.io/github/wegar-2/pycs)
+
+
+This trivial package provides simple interface (consisting of three functions described below) 
+that allows you to download the selected types of time series made available 
+via [National Bank of Poland's REST API](http://api.nbp.pl/en.html).
+
+
+More specifically, the following time series can be downloaded using PyNBP:
+
+1. Average daily FX rates for select currencies 
+(cf. [NBP's table of daily FX rates against various currencies]() 
+for list of currencies for which exchange rates are published).
+2. Table of historical central bank interest rates.
+3. Gold prices in PLN (note: the gold prices published by NBP are prices of 1g of gold).
+4. Downloading of the daily central bank's [FX rates tables](https://nbp.pl/statystyka-i-sprawozdawczosc/kursy/) (A, B and C)
+
+Note: the table of historical interest is not *per se* provided via NBP's API.
+
+I provide code snippets illustrating how to get the data below.
+
+
+### Import *pynbpapi*
+
+```python
+import pynbpapi
+```
+
+or:
+
+```python
+from pynbpapi import (
+    get_gold_prices, get_interest_rates_table, get_fx_rate,
+    get_nbp_fx_tables, get_fx_rates)
+```
+
+### FX Rate For a Single Pair Against PLN
+To download USDPLN daily average FX rates for the dates range 2018-01-03 to 2021-04-05 
+(these dates are given in the ISO / %Y-%m-%d format) run:
+
+```python
+from pynbpapi import get_fx_rate
+from datetime import date
+
+data = get_fx_rate(ccy="usd", start=date(2018, 1, 3), end=date(2021, 4, 5))
+print(data.head())
+```
+
+Output:
+```
+         date  usdpln_rate
+0  2018-01-03       3.4616
+1  2018-01-04       3.4472
+2  2018-01-05       3.4488
+3  2018-01-08       3.4735
+4  2018-01-09       3.4992
+```
+
+### FX Rates For Multiple Pairs Against PLN
+To download USDPLN, EURPLN and CNYPLN daily average FX rates for the dates 
+range 2018-01-03 to 2021-04-05 
+(these dates are given in the ISO / %Y-%m-%d format)
+in the long format (alternatively - wide format can be chosen) run:
+
+```python
+from pynbpapi import get_fx_rates, Ccy
+from datetime import date
+
+data = get_fx_rates(
+    ccys=[Ccy.EUR, Ccy.USD, Ccy.CNY],
+    start=date(2018, 1, 3),
+    end=date(2021, 4, 5), 
+    fmt="long"
+)
+print(data.head())
+print(data.tail())
+```
+
+Output - head:
+```
+         date    rate    pair
+0  2018-01-03  4.1673  eurpln
+1  2018-01-04  4.1515  eurpln
+2  2018-01-05  4.1544  eurpln
+3  2018-01-08  4.1647  eurpln
+4  2018-01-09  4.1779  eurpln
+```
+And tail:
+```
+           date    rate    pair
+816  2021-03-29  0.6027  cnypln
+817  2021-03-30  0.6030  cnypln
+818  2021-03-31  0.6053  cnypln
+819  2021-04-01  0.5998  cnypln
+820  2021-04-02  0.5941  cnypln
+```
+
+
+
+### Table of Historical Interest Rates
+To download the table of historical interest rates set by NBP run:
+
+```python
+from pynbpapi import get_interest_rates_table
+from datetime import date
+
+data = get_interest_rates_table()
+print(data.tail())
+```
+
+Output:
+```
+   valid_from_date  lombard_rate  reference_rate  rediscount_rate  discount_rate  deposit_rate
+82      2022-04-07        0.0500          0.0450           0.0455         0.0460        0.0400
+83      2022-05-06        0.0575          0.0525           0.0530         0.0535        0.0475
+84      2022-06-09        0.0650          0.0600           0.0605         0.0610        0.0550
+85      2022-07-08        0.0700          0.0650           0.0655         0.0660        0.0600
+86      2022-09-08        0.0725          0.0675           0.0680         0.0685        0.0625
+```
+
+
+
+### Gold Prices in PLN
+To download gold prices in PLN for the dates range 2018-01-03 to 2021-04-05 run:
+
+```python
+from pynbpapi import get_gold_prices
+from datetime import date
+
+data = get_gold_prices(start=date(2018, 1, 3), end=date(2021, 4, 5))
+print(data.head())
+```
+
+Please keep in mind that the daily prices of gold published by 
+NBP are prices of 1g of gold in PLN. 
+
+Output:
+```
+         date  price_of_1g_of_gold_in_pln
+0  2018-01-03                      145.72
+1  2018-01-04                      146.36
+2  2018-01-05                      145.68
+3  2018-01-08                      146.06
+4  2018-01-09                      147.42
+```
+
+
+### Download Daily NBP's FX Rates Tables 
+To download FX rates table A for dates range 2026-02-18 to 2026-02-19 run:
+
+```python
+from pynbpapi import get_nbp_fx_tables
+from datetime import date
+data = get_nbp_fx_tables(table="A", start=date(2026, 2, 18), end=date(2026, 2, 19))
+```
+
+Please keep in mind that the daily prices of gold published by 
+NBP are prices of 1g of gold in PLN. 
+
+Output - head:
+```
+             currency code     mid table              no        date
+0     bat (Tajlandia)  THB  0.1137     A  033/A/NBP/2026  2026-02-18
+1   dolar amerykański  USD  3.5610     A  033/A/NBP/2026  2026-02-18
+2  dolar australijski  AUD  2.5204     A  033/A/NBP/2026  2026-02-18
+3     dolar Hongkongu  HKD  0.4556     A  033/A/NBP/2026  2026-02-18
+4    dolar kanadyjski  CAD  2.6078     A  033/A/NBP/2026  2026-02-18
+```
+
+And tail:
+```
+                   currency code       mid table              no        date
+59       rupia indonezyjska  IDR  0.000212     A  034/A/NBP/2026  2026-02-19
+60           rupia indyjska  INR  0.039242     A  034/A/NBP/2026  2026-02-19
+61  won południowokoreański  KRW  0.002472     A  034/A/NBP/2026  2026-02-19
+62    yuan renminbi (Chiny)  CNY  0.515200     A  034/A/NBP/2026  2026-02-19
+63                SDR (MFW)  XDR  4.909800     A  034/A/NBP/2026  2026-02-19
+```

pynbpapi-1.0.0/pynbpapi/__init__.py

@@ -0,0 +1,31 @@
+from .ccy import Ccy
+from .fx import get_fx_rate, get_fx_rates, get_nbp_fx_tables
+from .gold import get_gold_prices
+from .interest_rates import get_interest_rates_table
+
+__all__ = [
+    "Ccy",
+    "get_fx_rate",
+    "get_fx_rates",
+    "get_gold_prices",
+    "get_interest_rates_table",
+    "get_nbp_fx_tables",
+]
+
+import logging
+
+
+def configure_logging():
+    console_handler = logging.StreamHandler()
+    formatter = logging.Formatter(
+        '%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+    console_handler.setFormatter(formatter)
+
+    logger = logging.getLogger()
+    if logger.hasHandlers():
+        logger.handlers.clear()
+    logger.setLevel(logging.INFO)
+    logger.addHandler(console_handler)
+
+
+configure_logging()

pynbpapi-1.0.0/pynbpapi/ccy.py

@@ -0,0 +1,36 @@
+from enum import Enum
+
+
+class Ccy(Enum):
+    THB = "THB"
+    USD = "USD"
+    AUD = "AUD"
+    HKD = "HKD"
+    CAD = "CAD"
+    NZD = "NZD"
+    SGD = "SGD"
+    EUR = "EUR"
+    HUF = "HUF"
+    CHF = "CHF"
+    GBP = "GBP"
+    UAH = "UAH"
+    JPY = "JPY"
+    CZK = "CZK"
+    DKK = "DKK"
+    ISK = "ISK"
+    NOK = "NOK"
+    SEK = "SEK"
+    RON = "RON"
+    BGN = "BGN"
+    TRY = "TRY"
+    ILS = "ILS"
+    CLP = "CLP"
+    PHP = "PHP"
+    MXN = "MXN"
+    ZAR = "ZAR"
+    BRL = "BRL"
+    MYR = "MYR"
+    IDR = "IDR"
+    INR = "INR"
+    KRW = "KRW"
+    CNY = "CNY"

pynbpapi-1.0.0/pynbpapi/common.py

@@ -0,0 +1,37 @@
+from datetime import date, timedelta
+from json import loads
+from dateutil.relativedelta import relativedelta
+from requests import get
+
+__all__ = [
+    "get_default_dates_range",
+    "run_web_api_query",
+    "split_dates_range_into_smaller_chunks"
+]
+
+
+def get_default_dates_range() -> tuple[date, date]:
+    date_end = date.today() - timedelta(days=1)
+    date_start = date_end + relativedelta(years=-1) + timedelta(days=1)
+    return date_start, date_end
+
+
+def run_web_api_query(url: str) -> dict:
+    return loads(get(url=url, timeout=180).text)
+
+
+def split_dates_range_into_smaller_chunks(
+        start: date,
+        end: date
+) -> list[tuple[date, date]]:
+    if (end - start).days >= 367:
+        temp = start
+        out = []
+        while temp < end:
+            out.append(
+                (temp, temp + relativedelta(years=1) - timedelta(days=1))
+            )
+            temp = temp + relativedelta(years=1)
+        out[-1] = (out[-1][0], end)
+        return out
+    return [(start, end)]

pynbpapi-1.0.0/pynbpapi/exceptions.py

@@ -0,0 +1,17 @@
+from datetime import date
+
+__all__ = [
+    "InvalidStartEndDatesException",
+    "InvalidCurrencyException"
+]
+
+
+class InvalidStartEndDatesException(ValueError):
+    def __init__(self, start: date, end: date):
+        self.message: str = (f"Inconsistent start={start.isoformat()} and "
+                             f"end={end.isoformat()} dates! ")
+
+
+class InvalidCurrencyException(ValueError):
+    def __init__(self, ccy: str):
+        self.message = f"Encountered invalid currency: {ccy}"

pynbpapi-1.0.0/pynbpapi/fx.py

@@ -0,0 +1,135 @@
+from datetime import date, datetime
+from functools import reduce
+from typing import Literal, Union
+
+import pandas as pd
+
+from pynbpapi.common import (
+    split_dates_range_into_smaller_chunks, run_web_api_query)
+from pynbpapi.ccy import Ccy
+from pynbpapi.exceptions import (
+    InvalidStartEndDatesException, InvalidCurrencyException)
+
+__all__ = ["get_fx_rate", "get_fx_rates", "get_nbp_fx_tables"]
+
+
+def _validate_fx_table_code(code: str) -> None:
+    if code not in ["A", "B", "C"]:
+        raise ValueError(f"Invalid NBP code value {code}")
+
+
+def _validate_start_end_dates(start: date, end: date) -> None:
+    if start > end:
+        raise InvalidStartEndDatesException(start, end)
+
+
+def _validate_ccys(ccys: list) -> None:
+    for i in range(len(ccys)):
+        ccy = ccys[i]
+        if not (isinstance(ccy, str) or isinstance(ccy, Ccy)):
+            raise TypeError(
+                f"Encountered ccy of invalid type: {type(ccy)=}"
+            )
+        try:
+            if isinstance(ccy, str):
+                ccy = Ccy(ccy)
+        except ValueError:
+            raise InvalidCurrencyException(ccy=ccy)
+        ccys[i] = ccy
+
+
+def _parse_fx_json(json_) -> pd.DataFrame:
+    return pd.DataFrame(data=json_["rates"]).rename(
+        columns={"effectiveDate": "date", "mid": "rate"}
+    ).drop(columns=["no"], inplace=False)
+
+
+def _get_fx_api_query(ccy: Ccy, start: date, end: date) -> str:
+    return (f"https://api.nbp.pl/api/exchangerates"
+            f"/rates/a/{ccy.name.lower()}/{start.isoformat()}/"
+            f"{end.isoformat()}/")
+
+
+def get_fx_rate(
+        ccy: Ccy | str,
+        start: date,
+        end: date
+) -> pd.DataFrame:
+    _validate_ccys(ccys=[ccy.upper() if isinstance(ccy, str) else ccy])
+    if not isinstance(ccy, Ccy):
+        ccy = Ccy(ccy.upper())
+    chunks = split_dates_range_into_smaller_chunks(start=start, end=end)
+    list_dfs = []
+    for start_, end_ in chunks:
+        list_dfs.append(
+            _parse_fx_json(
+                json_=run_web_api_query(
+                    url=_get_fx_api_query(ccy=ccy, start=start_, end=end_)
+                )
+            )
+        )
+    return pd.concat(
+        list_dfs,
+        axis=0
+    ).rename(columns={
+        "rate": f"{ccy.name.lower()}pln"
+    }, inplace=False).reset_index(
+        inplace=False,
+        drop=True
+    ).copy(deep=True)[["date", f"{ccy.name.lower()}pln"]]
+
+
+def get_fx_rates(
+        ccys: Union[str, Ccy, list[Union[str, Ccy]]],
+        start: date,
+        end: date,
+        fmt: Literal["long", "wide"] = "long",
+        fill_nas: bool = True
+) -> pd.DataFrame:
+    _validate_start_end_dates(start, end)
+    if isinstance(ccys, str) or isinstance(ccys, Ccy):
+        ccys = [ccys]
+    _validate_ccys(ccys)
+
+    datas: list[pd.DataFrame] = []
+    for ccy in ccys:
+        data = get_fx_rate(ccy, start, end)
+        if fmt == "long":
+            pair_name: str = f"{ccy.name.lower()}pln"
+            data["pair"] = pair_name
+            data = data.rename(columns={pair_name: "rate"})
+        datas.append(data)
+
+    if fmt == "long":
+        return pd.concat(datas, axis=0)
+
+    data = reduce(lambda x, y: pd.merge(x, y, on="date", how="outer"), datas)
+    if fill_nas:
+        data = data.ffill(axis=0)
+        data = data.bfill(axis=0)
+    return data.sort_values(by="date", ascending=True)
+
+
+def get_nbp_fx_tables(
+        table: Literal["A", "B", "C"],
+        start: date,
+        end: date
+) -> pd.DataFrame:
+    _validate_fx_table_code(code=table)
+    _validate_start_end_dates(start, end)
+    tables = run_web_api_query(
+        url=f"https://api.nbp.pl/api/exchangerates/tables/"
+            f"{table}/{start.isoformat()}/{end.isoformat()}/"
+    )
+    parsed_tables: list[pd.DataFrame] = []
+    for table_ in tables:
+        rates_data = pd.DataFrame(table_["rates"])
+        rates_data["table"] = table_["table"]
+        rates_data["no"] = table_["no"]
+        rates_data["date"] = datetime.strptime(
+            table_["effectiveDate"], "%Y-%m-%d").date()
+        parsed_tables.append(rates_data)
+
+    return pd.concat(
+        parsed_tables, axis=0
+    ).reset_index(drop=True)

pynbpapi-1.0.0/pynbpapi/gold.py

@@ -0,0 +1,32 @@
+from datetime import date
+import pandas as pd
+from pynbpapi.common import (
+    run_web_api_query, split_dates_range_into_smaller_chunks)
+
+__all__ = ["get_gold_prices"]
+
+
+def _get_gold_prices_url(start: date, end: date) -> str:
+    return (f"https://api.nbp.pl/api/cenyzlota/"
+            f"{start.isoformat()}/{end.isoformat()}/")
+
+
+def _get_gold_prices_chunk(start: date, end: date) -> pd.DataFrame:
+    return pd.DataFrame(
+        data=run_web_api_query(
+            url=_get_gold_prices_url(start=start, end=end)
+        )
+    ).rename(
+        columns={"data": "date", "cena": "price_of_1g_of_gold_in_pln"},
+        inplace=False
+    ).copy(deep=True)
+
+
+def get_gold_prices(start: date, end: date):
+    chunks = split_dates_range_into_smaller_chunks(start=start, end=end)
+    dfs = []
+    for start_, end_ in chunks:
+        dfs.append(_get_gold_prices_chunk(start=start_, end=end_))
+    return pd.concat(
+        dfs, axis=0
+    ).reset_index(drop=True, inplace=False).copy(deep=True)

pynbpapi-1.0.0/pynbpapi/interest_rates.py

@@ -0,0 +1,62 @@
+from datetime import datetime
+from collections import defaultdict
+import xml.etree.ElementTree as ET
+import requests
+import numpy as np
+import pandas as pd
+
+__all__ = ["get_interest_rates_table"]
+
+
+RATES_NAMES_DICT: dict[str, str] = {
+    "dys": "discount_rate", "dep": "deposit_rate", "lom": "lombard_rate",
+    "ref": "reference_rate", "red": "rediscount_rate"
+}
+
+
+def get_interest_rates_table() -> pd.DataFrame:
+    xml = load_xml()
+    data_dict = parse_xml(xml=xml)
+    return data_dict_to_dataframe(data_dict)
+
+
+def load_xml() -> str:
+    response = requests.get( # noqa
+        "https://static.nbp.pl/dane/stopy/stopy_procentowe_archiwum.xml",
+        timeout=120
+    )
+    response_text = response.text
+    return response_text[response_text.find("<?xml version"):]
+
+
+def parse_xml(xml: str):
+    tree_root = ET.fromstring(xml)  # pylint: disable=E1101
+    entries = tree_root.findall("pozycje") # noqa
+    data_dict: defaultdict = defaultdict(dict)
+    for entry in entries:
+        rates_list = []
+        for el in entry.findall("pozycja"):
+            rates_list.append((el.attrib["id"], el.attrib["oprocentowanie"]))
+        data_dict[entry.attrib["obowiazuje_od"]] = dict(rates_list)
+    rates_to_keep: list = list(RATES_NAMES_DICT.keys())
+    out_dict = {}
+    for k in data_dict:
+        out_dict[k] = {
+            el: float(data_dict[k][el].replace(",", "."))/100
+            for el in rates_to_keep if el in data_dict[k].keys()
+        }
+        for rate in rates_to_keep:
+            if rate not in out_dict[k].keys():
+                out_dict[k][rate] = np.nan
+    return out_dict
+
+
+def data_dict_to_dataframe(data_dict: dict) -> pd.DataFrame:
+    df = pd.DataFrame.from_dict(data=data_dict, orient="index")
+    df.index = pd.Index([datetime.strptime(el, "%Y-%m-%d") for el in df.index])
+    df.reset_index(inplace=True, drop=False)
+    dict_cols_renaming = {
+        **RATES_NAMES_DICT, **{"index": "valid_from_date"}
+    }
+    df.rename(columns=dict_cols_renaming, inplace=True)
+    return df

pynbpapi-1.0.0/pyproject.toml

@@ -0,0 +1,25 @@
+[project]
+name = "pynbpapi"
+version = "1.0.0"
+description = "Tidy downloading of National Bank of Poland interest rates, FX rates and gold price data"
+readme = "README.md"
+requires-python = ">=3.11"
+keywords = [
+    "NBP", "FX", "PLN", "gold", "API", "REST-API", "FX-rates", "zloty"
+]
+authors = [
+  {name = "Artur Wegrzyn", email = "awegrzyn17@gmail.com" }
+]
+maintainers = [
+  {name = "Artur Wegrzyn", email = "awegrzyn17@gmail.com" }
+]
+dependencies = [
+    "pandas",
+    "requests",
+    "python-dateutil",
+    "loguru"
+]
+
+[build-system]
+requires = ["setuptools>=69.0.3", "wheel"]
+build-backend = "setuptools.build_meta"

pynbpapi-1.0.0/requirements.txt

@@ -0,0 +1,28 @@
+certifi==2022.12.7
+charset-normalizer==3.1.0
+coverage==7.4.1
+flake8==7.3.0
+idna==3.4
+iniconfig==2.0.0
+loguru==0.7.2
+mccabe==0.7.0
+mypy==1.8.0
+mypy-extensions==1.0.0
+numpy==1.26.4
+packaging==23.2
+pandas==2.0.1
+pandas-stubs==2.2.0.240218
+pluggy==1.4.0
+pycodestyle==2.14.0
+pyflakes==3.4.0
+pytest==8.0.1
+python-dateutil==2.8.2
+pytz==2023.3
+requests==2.31.0
+six==1.16.0
+types-python-dateutil==2.8.19.20240106
+types-pytz==2024.1.0.20240203
+types-requests==2.31.0.20240218
+typing_extensions==4.9.0
+tzdata==2023.3
+urllib3==2.2.1

pynbpapi-1.0.0/tests/test_common.py

@@ -0,0 +1,19 @@
+from datetime import date, timedelta
+from dateutil.relativedelta import relativedelta
+from pynbpapi.common import (get_default_dates_range,
+                             split_dates_range_into_smaller_chunks)
+
+
+def test_get_default_dates_range():
+    start, end = get_default_dates_range()
+    assert end == date.today() - timedelta(days=1)
+    assert start == end + relativedelta(years=-1) + timedelta(days=1)
+
+
+def test_split_dates_range_into_smaller_chunks():
+    list_ = split_dates_range_into_smaller_chunks(
+        start=date(2019, 1, 1), end=date(2022, 9, 30))
+    assert isinstance(list_, list)
+    assert len(list_) == 4
+    assert list_[0][0] == date(2019, 1, 1)
+    assert list_[2][1] == date(2021, 12, 31)

pynbpapi-1.0.0/tests/test_fx.py

@@ -0,0 +1,13 @@
+from datetime import date
+import pandas as pd
+from pynbpapi.fx import get_fx_rate
+from pynbpapi.ccy import Ccy
+
+
+def test_get_fx_rates_for_currency_usd():
+    data = get_fx_rate(
+        ccy=Ccy.USD, start=date(2021, 3, 13), end=date(2022, 4, 15)
+    )
+    assert isinstance(data, pd.DataFrame)
+    assert data.shape[1] == 2
+    assert data.iloc[10, 1] == 3.957

pynbpapi-1.0.0/tests/test_gold.py

@@ -0,0 +1,10 @@
+from datetime import date
+import numpy as np
+import pandas as pd
+from pynbpapi.gold import get_gold_prices
+
+
+def test_get_gold_prices():
+    data = get_gold_prices(start=date(2017, 8, 3), end=date(2021, 3, 13))
+    assert isinstance(data, pd.DataFrame)
+    assert np.all(data.columns == ["date", "price_of_1g_of_gold_in_pln"])

pynbpapi-1.0.0/tests/test_interest_rates.py

@@ -0,0 +1,13 @@
+import numpy as np
+import pandas as pd
+from pynbpapi.interest_rates import get_interest_rates_table
+
+
+def test_df_get_interest_rates_archive():
+    data = get_interest_rates_table()
+    assert isinstance(data, pd.DataFrame)
+    assert data.shape[1] == 6
+    assert (np.all(data.columns == [
+            'valid_from_date', 'lombard_rate', 'reference_rate',
+            'rediscount_rate', 'discount_rate', 'deposit_rate']
+        ))