writememe / uplift-your-banking

A Python toolkit to manage your budgeting and tracking of your Up Bank accounts.

Uplift your banking with Up

A Python toolkit to manage your budgeting and tracking of your Up Bank accounts.

This is built on the work of @jcwillox who did the hard yards with creating the up-bank-api client

You can use this toolkit to track your tagged transactions, perform budget variance analysis and perform spend analysis over different time periods.

All reports outputted are in Excel, but given that they are Pandas dataframes, there is nothing stopping the outputs being sent to other file formats.

Pre-requisites

The following pre-requisites are assumed when using this toolkit:

• Understanding of Python
• Python 3.10 or greater installed
• Ability to read/create CSV and JSON files
• An Up Bank account, if you don't have one, feel free to create one using my invite code
• Poetry installed on your machine

Setup

The following steps need to be followed:

1. Setup your personal access token from the Up Developer Documentation
2. Set the personal access token as the UP_TOKEN environmental variable

export UP_TOKEN="<YOUR_TOKEN>"

3. Setup Poetry, which will install the dependencies from the poetry.lock file:

poetry install

Examples

An examples_folder has been provided with some examples.

The examples are as follows:

Example Name	Description	Comments
untagged_withdrawals	Find all transactions for an account within a defined period and generate an Excel report with the untagged transactions
all_tag_account_analysis	Perform a tag analysis for all tag-based transactions for the last three months and save to an Excel file	Relies upon transactions being tagged through the app or the API
budget_tracking	Perform a budget vs spend analysis for tags, for an account within a defined period and generate an Excel report with the untagged transactions	See the BUDGET_TRACKER_README for some help on the formatting of your budget file.
multi_report_workflow	Perform all three examples above within a single workflow	See the BUDGET_TRACKER_README for some help on the formatting of your budget file.