brendanator / pecuny

Pecuny written with fastapi

Pecuny

Budgeting app written in FastAPI with Jinja2. This is my learning project for various subjects:

• Domain Driven Design
• Architecture
• Async
• API Development
• what else there is in a project

Dev notes

Prerequisites

1. python ^3.12 installed
2. python-dev package installed
3. install poetry with: pip install -r dev-requirements.txt

Install packages

Use poetry to install packages: poetry install --with dev

VSCode Setup

Set the correct env in VS Code with:

1. Get the env path with: poetry env info --path
2. Ctrl + P
3. Search for Python interpreter
4. Set the path from step 1

Starting backend

Database docker compose up -d

FastAPI in docker docker run --name=pecuny --rm -dp 8000:8000 --env-file .env pecuny

FastAPI directly uvicorn app.main:app or via VS Code debugger

Database

Migrate DB with: poetry run alembic upgrade head

Create new revision with: poetry run alembic revision --autogenerate -m "your message"

Tests

Use the VS Code Test Module or use the following commands

run all tests with: poetry run pytest -v -x -s --disable-warnings

run single test with: poetry run pytest test_transactions.py::test_update_transaction -v -x -s