A client for the Heron Data API
Project description
Heron Python Library
The Heron Python library provides easy access to the Heron Data API from applications written in Python.
Documentation
See the 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 heron
heron.basic_auth_username = "your-username"
heron.basic_auth_password = "super-random-password"
# optionally, specify the provider pull bank data from, in lowercase
heron.data_source = "plaid"
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
Clone 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.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
heron-data-0.0.3.tar.gz
(6.0 kB
view hashes)
Built Distribution
Close
Hashes for heron_data-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 152a6adf2936b01ecfc4c1d04c9463049d26459b9ab56f42da59b8c3b30783a3 |
|
MD5 | 0e06953393caf7555adb678cda1f238f |
|
BLAKE2b-256 | 44241f700efd538c337bce4ade221558fa1e731986ed4cb4207de08ff747cbb1 |