/finance

Sync your banks transactions to Google Spreadsheets

Primary LanguagePython

finance

This app syncs your transactions from your bank accounts into a Google Spreadsheet inside a Google Drive.

Currently only Nubank is synced.

Getting started

Prerequisites

This project uses Python 3.9+, make sure you have a valid Python version available.

  • poetry (dependency management) 
    curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3 -
  • Install dependencies 
    make install

To run the script:

poetry run python finance/main.py

You must define the following environment variables to run the app:

# Spreadsheet KEY (living in a Google Drive folder) that it's going to contain all the transactions
GOOGLE_SPREADSHEET_KEY: 'CHANGEME' 

# Nubank credentials
NUBANK_CPF: 'CHANGEME'
NUBANK_PASSWORD: 'CHANGEME'

# GCP project containing the bucket used for this script (deployed as Cloud Function) 
GCP_BUCKET_PROJECT: 'CHANGEME'

# Bucket containing the required credentials from the bank accounts to authenticate (e.g certificates)
GCP_BUCKET_NAME: 'CHANGEME'

You can run the project with Docker too:

docker build -t finance .
docker run --rm -ti -e GOOGLE_SPREADSHEET_KEY='' -e NUBANK_CPF='' \
-e NUBANK_PASSWORD='' -e GCP_BUCKET_PROJECT='' \
-e GCP_BUCKET_NAME='' finance