https://github.com/billthan/jupyter-finance
A Docker based solution leveraging Plaid API data to automate and store personal financial data in PostgreSQL for analysis in Jupyter Notebooks.
https://github.com/billthan/jupyter-finance
budget finance jupyter-notebook plaid postgresql powerbi
Last synced: about 1 month ago
JSON representation
A Docker based solution leveraging Plaid API data to automate and store personal financial data in PostgreSQL for analysis in Jupyter Notebooks.
- Host: GitHub
- URL: https://github.com/billthan/jupyter-finance
- Owner: billthan
- License: apache-2.0
- Created: 2025-01-07T04:27:18.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-12T04:50:32.000Z (2 months ago)
- Last Synced: 2025-02-12T05:35:01.144Z (2 months ago)
- Topics: budget, finance, jupyter-notebook, plaid, postgresql, powerbi
- Language: Jupyter Notebook
- Homepage:
- Size: 696 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jupyter Finance
[](https://github.com/billthan/jupyter-finance/actions/workflows/test.yaml)
[](https://github.com/billthan/jupyter-finance/actions/workflows/deploy.yaml)
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](https://nbdev.fast.ai/)
## Risks
This product is in a pre-release stage.
## Developer Guide
If you are new to using `nbdev` here are some useful pointers to get you
started.
### Setup environmental variables
Set up all your variables in `.env.example` first
``` sh
$ cp .env.example .env
```
### Install jupyter_finance in Development mode
``` sh
# 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
``` sh
$ ./build-dist.sh
# ensure prior instances of docker volumes are removed
$ docker-compose up --build
```
### Documentation
Documentation can be found hosted on this GitHub
[repository](https://github.com/billthan/jupyter-finance)’s [API
pages](https://billthan.github.io/jupyter-finance/).