Skip to main content

Wrapper for The Central Bank of the Russian Federation site API

Project description

cbrf

Wrapper for The Central Bank of the Russian Federation site API

Build Status PyPI version

Site and API of The Central Bank of the Russian Federation.

Installation

Stable version:

    pip install cbrf

Dev version:

    git clone https://github.com/Egregors/cbrf.git
    cd cbrf
    pip install -e .

Settings

For using with your own hostname set environment variables, for example

export CBRF_URL_SCHEME=https
export CBRF_URL_HOST=www.my-own-cbr.ru

How to use

API

To get raw XML answers you should use cbrf.api or cbrf.asyncio.api methods:

>>> import cbrf
>>> from cbrf.const import CurrencyCodes

>>> cbrf.get_currencies_info()
<Element 'Valuta' at 0x10b91f688>

>>> cbrf.get_daily_rates()
<Element 'ValCurs' at 0x10b82b9a8>

>>> date_1 = datetime(2001, 3, 2)
>>> date_2 = datetime(2001, 3, 14)
>>> get_dynamic_rates(date_req1=date_1, date_req2=date_2, currency_id=CurrencyCodes.USD)
<Element 'ValCurs' at 0x1107017c8>

>>> import asyncio

>>> asyncio.run(cbrf.asyncio.get_currencies_info())
<Element 'Valuta' at 0x102492ca0>

>>> asyncio.run(cbrf.asyncio.get_daily_rates())
<Element 'ValCurs' at 0x104c36c00>

>>> asyncio.run(cbrf.asyncio.get_dynamic_rates(date_req1=date_1, date_req2=date_2, currency_id=CurrencyCodes.USD))
<Element 'ValCurs' at 0x1026a4860>

Models

You can use base models for work with API (see examples in the tests).

CurrenciesInfo

>>> from cbrf.models import CurrenciesInfo

>>> c_info = CurrenciesInfo()
>>> c_info.get_by_id("R01305").name
'Ирландский фунт'
>>> c_info.get_by_id("R01305").eng_name
'Irish Pound'

>>> import asyncio
>>> from cbrf.asyncio import CurrenciesInfo

>>> c_info = asyncio.run(CurrenciesInfo().create())
>>> c_info.get_by_id("R01305").name
'Ирландский фунт'
>>> c_info.get_by_id("R01305").eng_name
'Irish Pound'

DailyCurrenciesRates

>>> from cbrf.models import DailyCurrenciesRates

>>> daily = DailyCurrenciesRates()
>>> daily.date
datetime.datetime(2017, 3, 11, 0, 0)
>>> daily.get_by_id('R01035').name
'Фунт стерлингов Соединенного королевства'
>>> daily.get_by_id('R01035').value
Decimal('72.0143')

>>> import asyncio
>>> from cbrf.asyncio import DailyCurrenciesRates

>>> daily = asyncio.run(DailyCurrenciesRates().create())
>>> daily.date
datetime.datetime(2017, 3, 11, 0, 0)
>>> daily.get_by_id('R01035').name
'Фунт стерлингов Соединенного королевства'
>>> daily.get_by_id('R01035').value
Decimal('72.0143')

DynamicCurrenciesRates

>>> from cbrf.models import DynamicCurrenciesRates

>>> date_1 = datetime(2001, 3, 2)
... date_2 = datetime(2001, 3, 14)
... id_code = 'R01235'
>>> dynamic_rates = DynamicCurrenciesRates(date_1, date_2, id_code)
>>> dynamic_rates.get_by_date(datetime(2001, 3, 8)).value
Decimal('28.6200')

>>> import asyncio
>>> from cbrf.asyncio import DynamicCurrenciesRates

>>> date_1 = datetime(2001, 3, 2)
... date_2 = datetime(2001, 3, 14)
... id_code = 'R01235'
>>> dynamic_rates = asyncio.run(DynamicCurrenciesRates(date_1, date_2, id_code).create())
>>> dynamic_rates.get_by_date(datetime(2001, 3, 8)).value
Decimal('28.6200')

Also, you can show DEBUG info, by setting logger level to DEBUG in your code:

import logging

logging.basicConfig(level=logging.DEBUG)

Linting & Tests

To run lint & tests:

make lint
make tests

You should install pytest first

Contributing

Bug reports, bug fixes, and new features are always welcome. Please open issues, and submit pull requests for any new code.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

cbrf-1.0.0-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file cbrf-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: cbrf-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 11.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.1

File hashes

Hashes for cbrf-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5620a1a7cd11ed581b29ec69c0f90ef004d8c40c4ee6b28d67e14ac99632ad81
MD5 d91a137ab41393bd2fe27a8e262d023e
BLAKE2b-256 ad1672ce49999f8f38cf970290ac6c3cfdd34895884f9a4c74301093d1f98398

See more details on using hashes here.

Supported by

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