| Name | bancointer JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | |
| Summary | Client to consume Banco Inter APIs |
| upload_time | 2024-01-13 21:46:14 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | |
| keywords |
bancointer
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Banco Inter
[](https://pypi.python.org/pypi/bancointer)
[](https://coveralls.io/github/lucasrcezimbra/bancointer?branch=master)
[](https://bancointer.readthedocs.io/en/latest/?version=latest)
Client to consume Banco Inter APIs
* Documentation: https://bancointer.readthedocs.io.
## Installation
```bash
pip install bancointer
```
## How to Use
### High-level API
```python
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
```python
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
```python
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
```python
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
```
Raw data
{
"_id": null,
"home_page": "",
"name": "bancointer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "bancointer",
"author": "",
"author_email": "Lucas Rangel Cezimbra <lucas@cezimbra.tec.br>",
"download_url": "https://files.pythonhosted.org/packages/30/65/ace5ea20285ebd1d5f1bda57e4d9e6901d22b52ec225f3ded9fb5ae948c1/bancointer-0.1.1.tar.gz",
"platform": null,
"description": "# Banco Inter\n\n\n[](https://pypi.python.org/pypi/bancointer)\n[](https://coveralls.io/github/lucasrcezimbra/bancointer?branch=master)\n[](https://bancointer.readthedocs.io/en/latest/?version=latest)\n\nClient to consume Banco Inter APIs\n\n* Documentation: https://bancointer.readthedocs.io.\n\n\n## Installation\n\n```bash\npip install bancointer\n```\n\n\n## How to Use\n\n### High-level API\n```python\nfrom inter import Inter\n\n\ninter = Inter(\n client_id=\"YOUR_CLIENT_ID\",\n client_secret=\"YOUR_CLIENT_SECRET\"\n cert_path='/path/to/certificado.crt',\n key_path='/path/to/chave.key',\n)\n\n# get September/2022 statements\ninter.get_statements(date(2022, 9, 1), date(2022, 9, 30))\n```\n\n#### Testing\n```python\nfrom inter.testing import InterFake\n\n\ndef my_function(inter):\n return inter.get_balance()\n\n\ndef test_my_function():\n inter = InterFake()\n\n result = my_function(inter)\n\n assert result == inter.balance\n```\n\n### Low-level API\n```python\nfrom datetime import date\n\nfrom inter import Client as Inter\n\n\ninter = Inter(\n \"YOUR_CLIENT_ID\",\n \"YOUR_CLIENT_SECRET\"\n '/path/to/certificado.crt',\n '/path/to/chave.key',\n)\n\n# get September/2022 statements\ninter.get_statements(date(2022, 9, 1), date(2022, 9, 30))\n```\n\n#### Testing\n```python\nfrom inter.testing import ClientFake\n\n\ndef my_function(client):\n return client.get_balance()\n\n\ndef test_my_function():\n client = ClientFake()\n\n result = my_function(client)\n\n assert result == client.balance\n```\n\n\n\n\n## Contributing\n\nContributions are welcome, feel free to open an Issue or Pull Request.\n\nPull requests must be for the `develop` branch.\n\n```\ngit clone https://github.com/lucasrcezimbra/bancointer\ncd bancointer\ngit checkout develop\npython -m venv .venv\nsource .venv/bin/activate\npip install .[test]\npre-commit install\npytest\n```\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Client to consume Banco Inter APIs",
"version": "0.1.1",
"project_urls": {
"changelog": "https://github.com/lucasrcezimbra/bancointer/blob/main/CHANGELOG.md",
"documentation": "https://bancointer.readthedocs.io/",
"homepage": "https://github.com/lucasrcezimbra/bancointer",
"repository": "https://github.com/lucasrcezimbra/bancointer"
},
"split_keywords": [
"bancointer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0320271d613523c3079d7ac203c364721fa3289f028783afebcfb41b841922d5",
"md5": "5aa44c4d1f94d13890ca90c4941fc335",
"sha256": "76cb9a8da43ba02a988b30e136f7c00e9e5646f13e5474cc465fc0bde0c1a41d"
},
"downloads": -1,
"filename": "bancointer-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5aa44c4d1f94d13890ca90c4941fc335",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 16551,
"upload_time": "2024-01-13T21:46:12",
"upload_time_iso_8601": "2024-01-13T21:46:12.458861Z",
"url": "https://files.pythonhosted.org/packages/03/20/271d613523c3079d7ac203c364721fa3289f028783afebcfb41b841922d5/bancointer-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3065ace5ea20285ebd1d5f1bda57e4d9e6901d22b52ec225f3ded9fb5ae948c1",
"md5": "2cfde60705e6d76e04b38dad0b83cca6",
"sha256": "8eeaa02c27ae3cfdb41df97c52464ceb39775f69d18e3ae92ccd5ee0b3ff739d"
},
"downloads": -1,
"filename": "bancointer-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "2cfde60705e6d76e04b38dad0b83cca6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 15354,
"upload_time": "2024-01-13T21:46:14",
"upload_time_iso_8601": "2024-01-13T21:46:14.122597Z",
"url": "https://files.pythonhosted.org/packages/30/65/ace5ea20285ebd1d5f1bda57e4d9e6901d22b52ec225f3ded9fb5ae948c1/bancointer-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-13 21:46:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lucasrcezimbra",
"github_project": "bancointer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bancointer"
}
