docker compose up -d
To access the application server, go to http://localhost:8180/
To carry out operations, use the Makefile.
$ make help
Please specify a build target. The choices are:
build Build all or c=<name> container
rebuild Stop containers (via 'down'), rebuilds services images (via 'build') and start services (via 'start')
up Start all or c=<name> containers in foreground
start Start all or c=<name> containers in background
stop Stop all or c=<name> containers
restart Restart all or c=<name> containers
logs Show logs for all or c=<name> containers
status Show status of containers
ps Alias of status
down Clean all data
clean Clean all data
install Install the poetry environment
check Run code quality tools.
flask Activate python and launch flask
ruffix Running ruff check --fix
test Test the code with mamba.
cov Coverage console mamba's tests
help Show help
This project utilizes Poetry for managing dependencies. To install dependencies, run:
poetry install
To run the server with gunicorn, use the following command:
gunicorn -w 2 -b 0.0.0.0:8080 --reload 'wsgi:app'
Alternatively, you can run the native Flask server with:
export FLASK_APP="wsgi:app"
flask run -h localhost -p 8000
For running Mamba tests with mock and expects, use:
poetry run mamba tests/test_mamba/**/*.py
For console report, run:
poetry run mamba tests/test_mamba/**/*.py --enable-coverage && poetry run coverage report -m --rcfile=pyproject.toml
To generate an html report, run:
poetry run mamba tests/test_mamba/**/*.py --enable-coverage && poetry run coverage html -d coverage --rcfile=pyproject.toml
Unittest
For running unittests with mock
poetry run python -m unittest discover -s tests/test_unittest
For console report, run:
poetry run coverage run --rcfile=pyproject.toml && poetry run coverage report -m --rcfile=pyproject.toml
To generate an html report, run:
poetry run coverage run --rcfile=pyproject.toml && poetry run coverage html -d coverage --rcfile=pyproject.toml