Heron Python
This library provides easy access to the Heron Data API from applications written in Python.
Documentation
No language-specific docs are currently maintained. For documentation on the raw REST API this library uses behind the scenes, see our OpenAPI Docs.
Installation
If you just want to use the package, just run:
pip install --upgrade heron-data
Install from source with:
python setup.py install
Requirements
- Python 3.8+
Usage
Import the heron package and set your config:
import os
import heron
heron.basic_auth_username = os.getenv("HERON_USERNAME")
heron.basic_auth_password = os.getenv("HERON_PASSWORD")
# Experimental: if you pull from a fintech API, specify it here to get
# automatic conversion into a Heron Data API format. Supported: plaid,
# finicity, yodlee, truelayer
heron.provider = "plaid"
Alternatively, set HERON_USERNAME and HERON_PASSWORD as environment variables which will be automatically picked up.
Then you can issue API requests using Python classes:
end_user = heron.EndUser.create(...)
transactions = heron.Transaction.create_many([...])
You can see a longer example in the examples/ directory.
Contributing
Fork this repository, and install dev dependencies:
pip install -r requirements.dev.txt
Run tests and capture coverage with:
coverage run -m unittest
See test coverage with:
coverage report
Run linting with flake8 and black:
flake8 . && black .
Make a PR against the main branch and it will be reviewed.
3 Sep 8, 2022
20 Jun 18, 2022
10 Nov 21, 2022
147 Dec 15, 2022
4 Dec 22, 2021
1 Nov 21, 2021
39 Jan 4, 2023
20 Sep 16, 2022
3 Jan 8, 2022
5 Oct 31, 2021
10 Mar 07, 2022
222 Jan 04, 2023
4 Nov 11, 2022
136 Dec 30, 2022
0 Aug 12, 2021
23 Jan 21, 2022
38 Jan 02, 2023
2 Mar 18, 2022
0 Dec 26, 2021
1 Jan 06, 2022
2 Mar 30, 2022
345 Dec 17, 2022
61 Dec 29, 2022
147 Sep 18, 2022
1.2k Jan 01, 2023
6 May 03, 2022
26 May 28, 2022
85 Jan 03, 2023
7 Nov 15, 2022