BusyBe Cloud

Backend API for busybe app

Local development

Python installation

Ensure you have Python installed, preferably version >= 3.12.x

brew install python
python --version

Run & Test

Setup venv

python -m venv venv
source venv/bin/activate

Install dependencies

pip install -r requirements.txt

Run server

uvicorn service.app:app --reload --host 0.0.0.0 --port 8080

Tests

Running Tests

pytest

Pre commit

Install local pre-commit hook

pip install pre-commit
pre-commit install

Install commit-msg hook

pre-commit install -t commit-msg

Run manually on all files

pre-commit run --all-files

OpenAPI docs

We are using swagger to document the api's

On running locally server you will find the swagger page here:

• swagger http://localhost:8080/docs
• redoc http://localhost:8080/redoc