Skip to content

ScottG489/ha-simplefin

Repository files navigation

ha-simplefin

maintenance-status

SimpleFIN integration for Home Assistant.

Features

  • Entites for balances for each of your accounts

Planned features

  • Entities for more fine-grained investment holdings
  • Transaction data?

Installation

First add this repository as a custom repository.

Setup

Prerequisites

Before setting up this integration, you need to get credentials by creating a SimpleFIN account. Connect your financial institutions to the platform, create a new "app", and record your setup token as this will need to be provided to the HA integration.

Open your Home Assistant instance and start setting up a new integration.

Development

Run the following to set up your development environment

python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements_test.txt

To run Home Assistant with this integration loaded:

hass -c config

Testing

To run unit tests with coverage:

pytest tests --cov=custom_components.simplefin --cov-report term-missing

Releasing

Create a new GitHub release. The release workflow takes care of the rest. When finished, it will be available to download via HACS.