Template repository for creating API server to dispatch simulation tasks to a queue of workers. The API typically recieves a post request with a json input file, sends this file to a parser which initiate a long simulation (like oemof). Once the simulation is done a json response is sent back. The json results can also be retrieved with the task id.
Run sudo docker-compose up -d --build to run the task queue and the webapp simulaneously.
Now the webapp is available at 127.0.0.1:5001
Run sudo docker-compose down to shut the services down.
Using redis
You have to start redis-server
service redis-server start
(to stop it use service redis-server stop)
Move to task_queue and run . setup_redis.sh to start the celery queue with redis a message
broker.
Using RabbitMQ
Using flask
In another terminal go the the root of the repo and run python flask_run.py
Now the flask app is available at 127.0.0.1:5001
Using fastapi
In another terminal go the the root of the repo and run . fastapi_run.sh
Now the flask app is available at 127.0.0.1:5001
While docker runs : https://vsupalov.com/rebuilding-docker-image-development/
RabbitMQ: https://www.rabbitmq.com/getstarted.html
https://riptutorial.com/flask/example/5831/return-a-json-response-from-flask-api
https://docs.celeryproject.org/en/3.1/getting-started/first-steps-with-celery.html#application
To build the docs simply go to the docs folder
cd docs
Install the requirements
pip install -r docs_requirements.txt
and run
make html
The output will then be located in docs/_build/html and can be opened with your favorite browser
Use black . to lint the python files inside the repo