Metadata-Version: 1.1
Name: flinks
Version: 0.1.0a1
Summary: A Python module for communicating with the Flinks.io API.
Home-page: https://github.com/impak-finance/flinks-python
Author: impak Finance
Author-email: tech@impakfinance.com
License: MIT
Description: flinks-python
        =============
        
        .. image:: https://travis-ci.org/impak-finance/flinks-python.svg?branch=master
            :target: https://travis-ci.org/impak-finance/flinks-python
        
        .. image:: https://codecov.io/gh/impak-finance/flinks-python/branch/master/graph/badge.svg
          :target: https://codecov.io/gh/impak-finance/flinks-python
        
        |
        
        **Flinks-python** 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.4+, Requests_ 2.0+.
        
        Installation
        ------------
        
        To install Flinks, please use pip_ (or pipenv_) as follows:
        
        .. code-block:: shell
        
            $ pip install --pre flinks
        
        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 flinks 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/
        
Keywords: flinks bank financial data institution
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
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.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
