fiobank
=======
|PyPI version| |Build Status| |Test Coverage|
`Fio Bank API <http://www.fio.cz/bank-services/internetbanking-api>`__
in Python.
Installation
------------
.. code:: sh
$ pip install fiobank
Usage
-----
First, get your API token.
.. image:: token.png
Initialization of the client:
.. code:: python
>>> from fiobank import FioBank
>>> client = FioBank(token='...', decimal=True)
Account information:
.. code:: python
>>> client.info()
{
'currency': 'CZK',
'account_number_full': 'XXXXXXXXXX/2010',
'balance': Decimal('42.00'),
'account_number': 'XXXXXXXXXX',
'bank_code': '2010'
}
Listing transactions within a period:
.. code:: python
>>> gen = client.period('2013-01-20', '2013-03-20')
>>> list(gen)[0]
{
'comment': 'N\xe1kup: IKEA CR, BRNO, CZ, dne 17.1.2013, \u010d\xe1stka 2769.00 CZK',
'recipient_message': 'N\xe1kup: IKEA CR, BRNO, CZ, dne 17.1.2013, \u010d\xe1stka 2769.00 CZK',
'user_identification': 'N\xe1kup: IKEA CR, BRNO, CZ, dne 17.1.2013, \u010d\xe1stka 2769.00 CZK',
'currency': 'CZK',
'amount': Decimal('-2769.0'),
'instruction_id': 'XXXXXXXXXX',
'executor': 'Vilém Fusek',
'date': datetime.date(2013, 1, 20),
'type': 'Platba kartou',
'transaction_id': 'XXXXXXXXXX'
}
Listing transactions from a single account statement:
.. code:: python
>>> client.statement(2013, 1) # 1 is January only by coincidence - arguments mean 'first statement of 2013'
Listing the latest transactions:
.. code:: python
>>> client.last() # return transactions added from last listing
>>> client.last(from_id='...') # sets cursor to given transaction_id and returns following transactions
>>> client.last(from_date='2013-03-01') # sets cursor to given date and returns following transactions
Conflict Error
--------------
`Fio API documentation <http://www.fio.cz/docs/cz/API_Bankovnictvi.pdf>`__
(Section 8.2) states that a single token should be used only once per
30s. Otherwise, an HTTP 409 Conflict will be returned and
``fiobank.ThrottlingError`` will be raised.
Contributing
------------
.. code:: shell
$ pip install -e .[tests]
$ pytest
Changelog
---------
See `GitHub Releases <https://github.com/honzajavorek/fiobank/releases>`_.
License: ISC
------------
© 2013 Honza Javorek mail@honzajavorek.cz
This work is licensed under the `ISC
license <https://en.wikipedia.org/wiki/ISC_license>`__.
.. |PyPI version| image:: https://badge.fury.io/py/fiobank.svg
:target: https://badge.fury.io/py/fiobank
.. |Build Status| image:: https://travis-ci.org/honzajavorek/fiobank.svg?branch=master
:target: https://travis-ci.org/honzajavorek/fiobank
.. |Test Coverage| image:: https://coveralls.io/repos/github/honzajavorek/fiobank/badge.svg?branch=master
:target: https://coveralls.io/github/honzajavorek/fiobank?branch=master
Raw data
{
"_id": null,
"home_page": "https://github.com/honzajavorek/fiobank",
"name": "fiobank",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "bank api wrapper sdk fio",
"author": "Honza Javorek",
"author_email": "mail@honzajavorek.cz",
"download_url": "https://files.pythonhosted.org/packages/4c/d5/271804cfdc87005ad1e81116a3bbdfb874bd1dc4e8f5b52286d85778fe9d/fiobank-3.1.0.tar.gz",
"platform": null,
"description": "fiobank\n=======\n\n|PyPI version| |Build Status| |Test Coverage|\n\n`Fio Bank API <http://www.fio.cz/bank-services/internetbanking-api>`__\nin Python.\n\nInstallation\n------------\n\n.. code:: sh\n\n $ pip install fiobank\n\nUsage\n-----\n\nFirst, get your API token.\n\n.. image:: token.png\n\nInitialization of the client:\n\n.. code:: python\n\n >>> from fiobank import FioBank\n >>> client = FioBank(token='...', decimal=True)\n\nAccount information:\n\n.. code:: python\n\n >>> client.info()\n {\n 'currency': 'CZK',\n 'account_number_full': 'XXXXXXXXXX/2010',\n 'balance': Decimal('42.00'),\n 'account_number': 'XXXXXXXXXX',\n 'bank_code': '2010'\n }\n\nListing transactions within a period:\n\n.. code:: python\n\n >>> gen = client.period('2013-01-20', '2013-03-20')\n >>> list(gen)[0]\n {\n 'comment': 'N\\xe1kup: IKEA CR, BRNO, CZ, dne 17.1.2013, \\u010d\\xe1stka 2769.00 CZK',\n 'recipient_message': 'N\\xe1kup: IKEA CR, BRNO, CZ, dne 17.1.2013, \\u010d\\xe1stka 2769.00 CZK',\n 'user_identification': 'N\\xe1kup: IKEA CR, BRNO, CZ, dne 17.1.2013, \\u010d\\xe1stka 2769.00 CZK',\n 'currency': 'CZK',\n 'amount': Decimal('-2769.0'),\n 'instruction_id': 'XXXXXXXXXX',\n 'executor': 'Vil\u00e9m Fusek',\n 'date': datetime.date(2013, 1, 20),\n 'type': 'Platba kartou',\n 'transaction_id': 'XXXXXXXXXX'\n }\n\nListing transactions from a single account statement:\n\n.. code:: python\n\n >>> client.statement(2013, 1) # 1 is January only by coincidence - arguments mean 'first statement of 2013'\n\nListing the latest transactions:\n\n.. code:: python\n\n >>> client.last() # return transactions added from last listing\n >>> client.last(from_id='...') # sets cursor to given transaction_id and returns following transactions\n >>> client.last(from_date='2013-03-01') # sets cursor to given date and returns following transactions\n\nConflict Error\n--------------\n\n`Fio API documentation <http://www.fio.cz/docs/cz/API_Bankovnictvi.pdf>`__\n(Section 8.2) states that a single token should be used only once per\n30s. Otherwise, an HTTP 409 Conflict will be returned and\n``fiobank.ThrottlingError`` will be raised.\n\nContributing\n------------\n\n.. code:: shell\n\n $ pip install -e .[tests]\n $ pytest\n\nChangelog\n---------\n\nSee `GitHub Releases <https://github.com/honzajavorek/fiobank/releases>`_.\n\nLicense: ISC\n------------\n\n\u00a9 2013 Honza Javorek mail@honzajavorek.cz\n\nThis work is licensed under the `ISC\nlicense <https://en.wikipedia.org/wiki/ISC_license>`__.\n\n.. |PyPI version| image:: https://badge.fury.io/py/fiobank.svg\n :target: https://badge.fury.io/py/fiobank\n.. |Build Status| image:: https://travis-ci.org/honzajavorek/fiobank.svg?branch=master\n :target: https://travis-ci.org/honzajavorek/fiobank\n.. |Test Coverage| image:: https://coveralls.io/repos/github/honzajavorek/fiobank/badge.svg?branch=master\n :target: https://coveralls.io/github/honzajavorek/fiobank?branch=master\n",
"bugtrack_url": null,
"license": "ISC",
"summary": "Fio Bank API in Python",
"version": "3.1.0",
"project_urls": {
"Homepage": "https://github.com/honzajavorek/fiobank"
},
"split_keywords": [
"bank",
"api",
"wrapper",
"sdk",
"fio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ad4561938ddac54287b0dcbf80e7b64820ee940a8a5d6b14b1174634467eba1c",
"md5": "a4fe0782a77734d517dcb79b1a2b11ac",
"sha256": "155ded544cc74737da275044fb887b8733cb42b0cce67f02c00ff889bf6a400b"
},
"downloads": -1,
"filename": "fiobank-3.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "a4fe0782a77734d517dcb79b1a2b11ac",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 5063,
"upload_time": "2024-06-13T20:41:27",
"upload_time_iso_8601": "2024-06-13T20:41:27.612698Z",
"url": "https://files.pythonhosted.org/packages/ad/45/61938ddac54287b0dcbf80e7b64820ee940a8a5d6b14b1174634467eba1c/fiobank-3.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4cd5271804cfdc87005ad1e81116a3bbdfb874bd1dc4e8f5b52286d85778fe9d",
"md5": "257676f0f51531e32539798749eff7e3",
"sha256": "f232f7b30b696d2f57227ab65c737024a720807014342faee595ce8db451fe6d"
},
"downloads": -1,
"filename": "fiobank-3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "257676f0f51531e32539798749eff7e3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8075,
"upload_time": "2024-06-13T20:41:30",
"upload_time_iso_8601": "2024-06-13T20:41:30.142153Z",
"url": "https://files.pythonhosted.org/packages/4c/d5/271804cfdc87005ad1e81116a3bbdfb874bd1dc4e8f5b52286d85778fe9d/fiobank-3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-13 20:41:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "honzajavorek",
"github_project": "fiobank",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "fiobank"
}
JSON
