Metadata-Version: 2.0
Name: pycbrf
Version: 0.2.0
Summary: Tools to query Bank of Russia
Home-page: https://github.com/idlesign/pycbrf
Author: Igor `idle sign` Starikov
Author-email: idlesign@yandex.ru
License: BSD 3-Clause License
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: BSD License
Provides-Extra: cli
Requires-Dist: dbf-light
Requires-Dist: requests
Provides-Extra: cli
Requires-Dist: click; extra == 'cli'

pycbrf
======
https://github.com/idlesign/pycbrf

.. image:: https://img.shields.io/pypi/v/pycbrf.svg
    :target: https://pypi.python.org/pypi/pycbrf

.. image:: https://img.shields.io/pypi/l/pycbrf.svg
    :target: https://pypi.python.org/pypi/pycbrf

.. image:: https://img.shields.io/coveralls/idlesign/pycbrf/master.svg
    :target: https://coveralls.io/r/idlesign/pycbrf

.. image:: https://img.shields.io/travis/idlesign/pycbrf/master.svg
    :target: https://travis-ci.org/idlesign/pycbrf

.. image:: https://landscape.io/github/idlesign/pycbrf/master/landscape.svg?style=flat
   :target: https://landscape.io/github/idlesign/pycbrf/master


Description
-----------

*Tools to query Bank of Russia*

Provides methods to get the following information:

1. Exchange rates on various dates
2. Banks information (requisites, codes, numbers, etc.)


Requirements
------------

* Python 2.7, 3.4+
* `requests` Python package
* `dbf_light` Python package
* `click` package for CLI


Usage
-----

CLI
~~~

.. code-block:: bash

    $ pycbrf --help

    $ pycbrf rates
    $ pycbrf rates -d 2016-06-26 -c USD

    $ pycbrf banks
    $ pycbrf banks -b 045004641


CLI requires `click` package to be installed. Can be installed with `pycbrf` using::

    $ pip install pycbrf[cli]



Python
~~~~~~

.. code-block:: python

    from pycbrf import ExchangeRates, Banks


    rates = ExchangeRates('2016-06-26', locale_en=True)

    rates.date_requested  # 2016-06-26 00:00:00
    rates.date_received  # 2016-06-25 00:00:00
    rates.dates_match  # False
    # Note: 26th of June was a holiday, data is taken from the 25th.

    # Various indexing is supported:
    rates['USD'].name  # US Dollar
    rates['R01235'].name  # US Dollar
    rates['840'].name  # US Dollar

    rates['USD']
    '''
        ExchangeRate(
            id='R01235',
            name='US Dollar',
            code='USD',
            num='840',
            value=Decimal('65.5287'),
            par=Decimal('1'),
            rate=Decimal('65.5287'))
    '''

    banks = Banks()
    bank = banks['045004641']
    bank.swift  # SABRRUMMNH1
    bank.phone  # (383)2122004

    bank_annotated = Banks.annotate([bank])[0]
    for title, value in bank_annotated.items():
        print('%s: %s' % (title, value))



