pyflinks
=============
.. image:: https://img.shields.io/pypi/l/pyflinks.svg
:target: https://pypi.python.org/pypi/pyflinks/
:alt: License
.. image:: https://img.shields.io/pypi/pyversions/pyflinks.svg
:target: https://pypi.python.org/pypi/pyflinks
.. image:: https://img.shields.io/pypi/v/pyflinks.svg
:target: https://pypi.python.org/pypi/pyflinks/
:alt: Latest Version
.. image:: https://travis-ci.org/agmoss/pyflinks.svg?branch=master
:target: https://travis-ci.org/agmoss/pyflinks
.. image:: https://codecov.io/gh/agmoss/pyflinks/branch/master/graph/badge.svg
:target: https://codecov.io/gh/agmoss/pyflinks
|
**pyflinks** is a Python module for communicating with the
`Flinks.io API <https://sandbox.flinks.io/documentation/>`_.
.. contents:: Table of Contents
:local:
Main requirements
-----------------
Python_ 3.11+, Requests_ 2.0+.
Installation
------------
To install pyflinks, please use pip_ (or pipenv_) as follows:
.. code-block:: shell
$ pip install --pre pyflinks
Basic usage
-----------
The first step to interact with the Flinks v3 API interface is to initialize a ``flinks.Client``
instance. You'll need a Flinks customer ID (and optionally a private API instance URL) to perform
this initialization:
.. code-block:: python
>>> from pyflinks import Client
>>> client = Client('<CUSTOMER_ID>', 'https://sandbox.flinks.io/v3/')
Then you can easily interact with the implemented entities and the underlying API endpoints. Here
are some examples:
.. code-block:: python
>>> client.banking_services.authorize(login_id='<LOGIN_ID>', most_recent_cached=True)
>>> client.banking_services.get_accounts_summary('<REQUEST_ID>')
Authors
-------
impak Finance <tech@impakfinance.com>.
License
-------
MIT. See ``LICENSE`` for more details.
.. _pip: https://github.com/pypa/pip
.. _pipenv: https://github.com/pypa/pipenv
.. _Python: https://www.python.org/
.. _Requests: http://docs.python-requests.org/en/master/
Raw data
{
"_id": null,
"home_page": "https://github.com/agmoss/pyflinks",
"name": "pyflinks",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "flinks bank financial data institution",
"author": "Andrew Moss",
"author_email": "andrew@m0ss.dev",
"download_url": "https://files.pythonhosted.org/packages/bd/e2/b81ebb8fadcbc71e792924a842cea90d117d0edee783c5fca21e4c54ed78/pyflinks-0.1.1.tar.gz",
"platform": null,
"description": "pyflinks\n=============\n\n.. image:: https://img.shields.io/pypi/l/pyflinks.svg\n :target: https://pypi.python.org/pypi/pyflinks/\n :alt: License\n\n.. image:: https://img.shields.io/pypi/pyversions/pyflinks.svg\n :target: https://pypi.python.org/pypi/pyflinks\n\n.. image:: https://img.shields.io/pypi/v/pyflinks.svg\n :target: https://pypi.python.org/pypi/pyflinks/\n :alt: Latest Version\n\n.. image:: https://travis-ci.org/agmoss/pyflinks.svg?branch=master\n :target: https://travis-ci.org/agmoss/pyflinks\n\n.. image:: https://codecov.io/gh/agmoss/pyflinks/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/agmoss/pyflinks\n\n|\n\n**pyflinks** is a Python module for communicating with the\n`Flinks.io API <https://sandbox.flinks.io/documentation/>`_.\n\n.. contents:: Table of Contents\n :local:\n\nMain requirements\n-----------------\n\nPython_ 3.11+, Requests_ 2.0+.\n\nInstallation\n------------\n\nTo install pyflinks, please use pip_ (or pipenv_) as follows:\n\n.. code-block:: shell\n\n $ pip install --pre pyflinks\n\nBasic usage\n-----------\n\nThe first step to interact with the Flinks v3 API interface is to initialize a ``flinks.Client``\ninstance. You'll need a Flinks customer ID (and optionally a private API instance URL) to perform\nthis initialization:\n\n.. code-block:: python\n\n >>> from pyflinks import Client\n >>> client = Client('<CUSTOMER_ID>', 'https://sandbox.flinks.io/v3/')\n\nThen you can easily interact with the implemented entities and the underlying API endpoints. Here\nare some examples:\n\n\n.. code-block:: python\n\n >>> client.banking_services.authorize(login_id='<LOGIN_ID>', most_recent_cached=True)\n >>> client.banking_services.get_accounts_summary('<REQUEST_ID>')\n\nAuthors\n-------\n\nimpak Finance <tech@impakfinance.com>.\n\nLicense\n-------\n\nMIT. See ``LICENSE`` for more details.\n\n\n.. _pip: https://github.com/pypa/pip\n.. _pipenv: https://github.com/pypa/pipenv\n.. _Python: https://www.python.org/\n.. _Requests: http://docs.python-requests.org/en/master/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python module for communicating with the Flinks.io API.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/agmoss/pyflinks"
},
"split_keywords": [
"flinks",
"bank",
"financial",
"data",
"institution"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "00546b9c771a3b246a36ef35910f18779794ad50ec867b7cc4a873760a2ee465",
"md5": "38d3601dfd27ab81c86924a019e7ad1d",
"sha256": "456de2c7587d23a35b54bf3a5eceeb77e866417dcfa81a76e21991dbfffbecaa"
},
"downloads": -1,
"filename": "pyflinks-0.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "38d3601dfd27ab81c86924a019e7ad1d",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 10348,
"upload_time": "2024-06-26T21:38:35",
"upload_time_iso_8601": "2024-06-26T21:38:35.354735Z",
"url": "https://files.pythonhosted.org/packages/00/54/6b9c771a3b246a36ef35910f18779794ad50ec867b7cc4a873760a2ee465/pyflinks-0.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bde2b81ebb8fadcbc71e792924a842cea90d117d0edee783c5fca21e4c54ed78",
"md5": "549ac547d112ef269c5e855e3f718a96",
"sha256": "018bd1dfd9fae0836ad4eb20ef92762cd5a25b37932d95970e31a898160b72eb"
},
"downloads": -1,
"filename": "pyflinks-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "549ac547d112ef269c5e855e3f718a96",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9496,
"upload_time": "2024-06-26T21:38:36",
"upload_time_iso_8601": "2024-06-26T21:38:36.328150Z",
"url": "https://files.pythonhosted.org/packages/bd/e2/b81ebb8fadcbc71e792924a842cea90d117d0edee783c5fca21e4c54ed78/pyflinks-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-26 21:38:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "agmoss",
"github_project": "pyflinks",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"tox": true,
"lcname": "pyflinks"
}
JSON
