iokiwi / moneyapp

Parsing OFX files for personal budgeting and financial insights
Mozilla Public License 2.0
3 stars 2 forks source link
hacktoberfest hacktoberfest2023

MoneyApp

Python Code Style

This is a semi serious app to try real world deployments of several technologies including Open Telemetry, HoneyComb, ECS and more.

Quick start with Docker Dev Environment

Copy the default config files. There's no need to change anything just yet.

cp app/.env.example app/.env
cp otel-collector-config.yaml.example otel-collector-config.yaml

Run the application. If its your first time running the app it will take a couple of minutes while containers get downloaded and built

docker compose up

You should be able to access the following services in your browser.

App http://localhost:8000/
Jaeger UI http://localhost:16686/

More helpful operations

Rebuild app container manually

docker compose build app

Contributing

All contributions should be formatted with black and flake8. This will be checked and enforced with CI/CD checks on pull requests.

Its recommended to install both of on your local workstation and either run them manually before pushing or have your IDE/editor run them automatically.

pip install -r requirements-dev.txt

Architecture

Dev (docker compose)

Architecture diagram showing the development environment for MoneyApp in docker compose