/bancointer

Client to consume Banco Inter APIs

Primary LanguagePythonGNU Lesser General Public License v2.1LGPL-2.1

Banco Inter

PyPI Coverage Status Documentation Status

Client to consume Banco Inter APIs

Installation

pip install bancointer

How to Use

High-level API

from inter import Inter


inter = Inter(
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET"
    cert_path='/path/to/certificado.crt',
    key_path='/path/to/chave.key',
)

# get September/2022 statements
inter.get_statements(date(2022, 9, 1), date(2022, 9, 30))

Testing

from inter.testing import InterFake


def my_function(inter):
    return inter.get_balance()


def test_my_function():
    inter = InterFake()

    result = my_function(inter)

    assert result == inter.balance

Low-level API

from datetime import date

from inter import Client as Inter


inter = Inter(
    "YOUR_CLIENT_ID",
    "YOUR_CLIENT_SECRET"
    '/path/to/certificado.crt',
    '/path/to/chave.key',
)

# get September/2022 statements
inter.get_statements(date(2022, 9, 1), date(2022, 9, 30))

Testing

from inter.testing import ClientFake


def my_function(client):
    return client.get_balance()


def test_my_function():
    client = ClientFake()

    result = my_function(client)

    assert result == client.balance

Contributing

Contributions are welcome, feel free to open an Issue or Pull Request.

Pull requests must be for the develop branch.

git clone https://github.com/lucasrcezimbra/bancointer
cd bancointer
git checkout develop
python -m venv .venv
source .venv/bin/activate
pip install .[test]
pre-commit install
pytest