jasmin68k / savings-manager-backend

Backend for Savings Manager

Savings Manager

Deployment / Contribution

Docker

1. jump into docker dir: cd docker
2. call: docker compose up -d to run postgres and savings_manager app App will be exposed to: localhost:8000

SwaggerUI: localhost:8000/docs Sphinx: localhost:8000/sphinx

To get the newest repo, just pull it and rebuilt docker: docker compose up --build

Manually

poetry

Poetry is used as deployment and dependency manager.

Linux (Ubuntu 22.04):

1. Install python 3.11 on your OS and add python 3.11 to PATH
2. Install pipx: sudo apt update && sudo apt install pipx
3. Install poetry: pipx install poetry --python 311
4. Install project dependencies: cd PROJECT_ROOT poetry install

Database

A postgres database is needed. To connect to the database, add a .env filge in: /src/envs with following information:

DB_DRIVER=postgresql+asyncpg
DB_NAME=savings_manager

DB_HOST=     [YOUR_HOSTADDRESS]
DB_PORT=     [YOUR_POSTGRES_DB_PORT]
DB_USER=     [YOUR_POSTGRES_DB_USER]
DB_PASSWORD= [YOUR_POSTGRES_DB_PASSWORD]

Example:

DB_DRIVER=postgresql+asyncpg
DB_NAME=savings_manager
DB_HOST=127.0.0.1
DB_PORT=5432
DB_USER=postgres
DB_PASSWORD=postgres

SqlAlchemy (ORM)

We will use SqlAlchemy to manage and access the SQL database.

To create and migrate the database tables, you need to use alembic by using the command: In project root dir poetry run alembic upgrade head

Hint: The database must be reachable.

CI/CD

GitHub Workflows is uses as CI/CD pipeline.

Github Action Items:

• poetry build --> TODO
• pytest check --> TODO
• codestyle check --> TODO

Code Documentation

Based on docstrings, sphinx will generate function documentation.

Usage:

1. Create rst Files base on current project:

In dir: ../sphinx use command: sphinx-apidoc -f -o source/ ../../src

2. Create HTML documentation:

In dir: ../sphinx use command: sphinx-build source build

For detailed description, see: Generating documentation from docstring using Sphinx

An update sphinx documentation bash script is located in dir script/. It will automatically update the sphinx documentation.

DEV

Alembic (Migration)

Init:

In our case, alembic already exists and don't need to be initialized. Just for documentation: alembic init -t async alembic in project root dir will initialized an alembic environment.

Migration:

Upgrade to a revision:

head (latest revision): alembic upgrade head

specific revision: alembic upgrade revision_id

Downgrade to a revision:

specific revision: alembic downgrade revision_id

specific revision (relative): alembic downgrade head-1

Create new migration:

alembic revision --autogenerate -m "Added account table"