add docker, requirements and docs

Author: subCode321

.github/workflows/build-windows-executable-app.yaml

@@ -259,7 +259,9 @@ jobs:
 
     - name: Create .bat file
       run: |
-          echo " start /min .\python-${{ env.PYTHON_VERSION }}\python -m streamlit run app.py local" > ${{ env.APP_NAME }}.bat
+          echo "start /min .\python-${{ env.PYTHON_VERSION }}\python -m redis-server" > ${{ env.APP_NAME }}.bat
+          echo "start /min .\python-${{ env.PYTHON_VERSION }}\python -m rq worker --with-scheduler" >> ${{ env.APP_NAME }}.bat
+          echo "start /min .\python-${{ env.PYTHON_VERSION }}\python -m streamlit run app.py local" >> ${{ env.APP_NAME }}.bat
 
     - name: Create All-in-one executable folder
       run: |

Dockerfile

@@ -141,6 +141,8 @@ RUN echo "0 3 * * * /root/miniforge3/envs/streamlit-env/bin/python /app/clean-up
 RUN echo "#!/bin/bash" > /app/entrypoint.sh && \
     echo "source /root/miniforge3/bin/activate streamlit-env" >> /app/entrypoint.sh && \
     echo "service cron start" >> /app/entrypoint.sh && \
+    echo "redis-server" >> /app/entrypoint.sh && \
+    echo "rq worker --with-scheduler" >> /app/entrypoint.sh && \
     echo "streamlit run app.py" >> /app/entrypoint.sh
 # make the script executable
 RUN chmod +x /app/entrypoint.sh

Dockerfile_simple

@@ -87,6 +87,8 @@ RUN echo "0 3 * * * /root/miniforge3/envs/streamlit-env/bin/python /app/clean-up
 RUN echo "#!/bin/bash" > /app/entrypoint.sh
 RUN echo "source /root/miniforge3/bin/activate streamlit-env" >> /app/entrypoint.sh && \
     echo "service cron start" >> /app/entrypoint.sh && \
+    echo "redis-server" >> /app/entrypoint.sh && \
+    echo "rq worker --with-scheduler" >> /app/entrypoint.sh && \
     echo "streamlit run app.py" >> /app/entrypoint.sh
 # make the script executable
 RUN chmod +x /app/entrypoint.sh

docs/installation.md

@@ -43,7 +43,9 @@ Create and activate the conda environment:
 
 Run the app via streamlit command in the terminal. *local* and *online* mode can be toggled in the settings.json. Learn more about *local* and *online* mode in the documentation page 📖 **OpenMS Template App**.
 
-`streamlit run app.py`
+1. Open a new terminal and run `redis-server` 
+2. On another terminal run `rq worker --with-scheduler` (multiple workers can be spawned)
+3. Finally start the application `streamlit run app.py`
 
 ## Docker
 

environment.yml

@@ -15,4 +15,6 @@ dependencies:
         - captcha==0.5.0
         - pyopenms_viz==1.0.0
         - streamlit-js-eval
-        - psutil==7.0.0
+        - psutil==7.0.0
+        - redis==5.2.1
+        - rq==2.1.0

requirements.txt

@@ -8,4 +8,6 @@ plotly==5.22.0
 captcha==0.5.0
 pyopenms_viz==1.0.0
 streamlit-js-eval
-psutil==7.0.0
+psutil==7.0.0
+redis==5.2.1
+rq==2.1.0

test_gui.py

@@ -5,7 +5,6 @@
 from pathlib import Path
 import shutil
 
-
 @pytest.fixture
 def launch(request):
     test = AppTest.from_file(request.param)