mirror of
https://github.com/fusion44/blitz_api.git
synced 2026-08-13 11:52:45 +02:00
4e038e8fc7
This is a feature that allows to fetch the app status via a celery task which stores the result in the Redis database and notifies the API of the change. The API sends a notification to connected clients via the SSE mechanism. Using a background task allows to avoid crashing the whole API if the script call fails. The by default the cache is refreshed every 30 minutes. This can be changed by setting the `BAPI_APP_STATUS_UPDATE_INTERVAL_MIN` environment variable. refs #123
76 lines
2.5 KiB
Makefile
76 lines
2.5 KiB
Makefile
CELERY_APP ?= app.celery_app
|
||
CELERY_BROKER_URL ?= redis://localhost:6379/0
|
||
TASK_NAME ?= app.apps.tasks.update_app_state_task
|
||
TASK_ARGS ?= '[]'
|
||
TASK_KWARGS ?= '{}'
|
||
|
||
.PHONY: celery-list-tasks celery-run-task
|
||
|
||
# The @ makes sure that the command itself isn't echoed in the terminal
|
||
help:
|
||
@echo "---------------HELP-----------------"
|
||
@echo "To clean the workspace type 'make clean'"
|
||
@echo "To install the projects dependencies type 'make install'"
|
||
@echo "To install the projects dependencies for development type 'make install-dev'"
|
||
@echo "To run the project type 'make run'"
|
||
@echo "To test the project type 'make test'"
|
||
@echo "To assess test coverage type 'make coverage'"
|
||
@echo "To generate the requirements.txt file for pip type 'make update-requirements-file'"
|
||
@echo "To sync current changes to a blitz for testing, type 'make sync-to-blitz'.\n ℹ️ Adjust connection values in scripts/push_to_blitz.sh"
|
||
@echo "To generate the client libraries type 'make generate-client-libs'"
|
||
@echo "To build the Docker regtest image type 'make docker-regtest-image'.\n ℹ️ The image will be available to docker as 'blitz_api'"
|
||
@echo "To list all celery tasks type 'make celery-list-tasks'"
|
||
@echo "To manually trigger a celery task type 'make celery-run-task [TASK_NAME TASK_ARGS TASK_KWARGS]'"
|
||
@echo "------------------------------------"
|
||
|
||
clean:
|
||
echo "Removing htmlcov folder and .coverage file"
|
||
rm -rf htmlcov .coverage
|
||
poetry run python -m pyclean .
|
||
|
||
install:
|
||
poetry run python -m pip install -r requirements.txt
|
||
|
||
install-dev:
|
||
poetry install
|
||
|
||
run:
|
||
poetry run python -m uvicorn app.main:app --reload
|
||
|
||
test:
|
||
poetry run python -m pytest
|
||
|
||
coverage:
|
||
poetry run python -m coverage run --source=. -m pytest
|
||
poetry run python -m coverage html
|
||
|
||
update-requirements-file:
|
||
poetry update && poetry export --without dev --output requirements.txt
|
||
|
||
sync-to-blitz:
|
||
bash scripts/sync_to_blitz.sh
|
||
|
||
generate-client-libs:
|
||
poetry run python gen_client_libs.py
|
||
|
||
docker-regtest-image:
|
||
docker build -f Dockerfile.regtest -t blitz_api .
|
||
|
||
remote-debugging-help:
|
||
bash scripts/remote_debugging.sh help
|
||
|
||
enable-remote-debugging:
|
||
bash scripts/remote_debugging.sh enable
|
||
|
||
disable-remote-debugging:
|
||
bash scripts/remote_debugging.sh disable
|
||
|
||
celery-list-tasks:
|
||
@echo "Listing registered Celery tasks..."
|
||
@poetry run celery -A $(CELERY_APP) inspect registered
|
||
|
||
celery-run-task:
|
||
@echo "Manually triggering Celery task: $(TASK_NAME)"
|
||
@echo " Args: $(TASK_ARGS)"
|
||
@echo " Kwargs: $(TASK_KWARGS)"
|
||
@poetry run celery -A $(CELERY_APP) call $(TASK_NAME) --args=$(TASK_ARGS) --kwargs=$(TASK_KWARGS)
|