Metadata-Version: 2.1
Name: pyflinks
Version: 0.1.0
Summary: A Python module for communicating with the Flinks.io API.
Home-page: https://github.com/agmoss/pyflinks
Author: Andrew Moss
Author-email: andrew@m0ss.dev
License: MIT
Keywords: flinks bank financial data institution
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
License-File: LICENSE
Requires-Dist: requests>=2.0

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/
