Cloudia - API

This repository contains the API application for the Cloudia project.

---

Project overview: https://github.com/germainlefebvre4/cloudia-project

Documentation: https://cloudia.readthedocs.io/

---

Getting started

Install required packages:

sudo apt update
sudo apt install python3-pip python3-dev
pip install poetry

Setup the databases:

docker compose up -d db redis
docker compose restart redis
docker compose exec -ti redis redis-cli config set stop-writes-on-bgsave-error no

Run the app:

poetry install
poetry run alembic upgrade head
poetry run python app/initial_data.py
poetry run uvicorn app.main:app --port=8080 --reload

Troubleshooting

Some distributions might miss some packages. These are some hints if needed:

# cryptography/cffi
sudo apt install build-essential libssl-dev libffi-dev libpq-dev

Development

Setup workspace

sudo apt update
sudo apt install python3-pip python3-dev
pip install poetry
poetry install

Run locally

This section use docker database called cloudia.

docker compose up -d db redis
docker compose restart redis
poetry run alembic upgrade head
poetry run python app/initial_data.py
poetry run uvicorn app.main:app --port=8080 --reload

Run tests

This section use docker database called cloudia_test.

docker compose up -d db_test redis_test
docker compose restart redis_test
poetry run pytest -sv app/tests/