Jupyter Finance

A Docker based solution leveraging Plaid API data to automate and store personal financial data in PostgreSQL for analysis in Jupyter Notebooks.

Development is facilitated through the use of notebook development framework: nbdev

Risks

This product is in a pre-release stage.

Developer Guide

Prerequisites

• Docker
• act
• nbdev

Setup environmental variables

Set up all your variables in .env.example first

$ cp .env.example .env

Install jupyter_finance in Development mode

# make sure jupyter_finance package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to jupyter_finance
$ nbdev_prepare

Building jupyter_finance in Development mode

$ ./build-dist.sh
# ensure prior instances of docker volumes are removed
$ docker-compose up --build

Running Github actions locally to test

$ act

Documentation

Documentation can be found hosted on this GitHub repository’s API pages.