Merge pull request #49 from NikolaosSokos/bug_fixingt

Bug fixing

Author: NikolaosSokos

.github/workflows/publish.yml

@@ -0,0 +1,69 @@
+name: Publish Python Package
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+      - 'v[0-9]+.[0-9]+.[0-9]+-alpha.[0-9]+'
+      - 'v[0-9]+.[0-9]+.[0-9]+-beta.[0-9]+'
+      - 'v[0-9]+.[0-9]+.[0-9]+-rc.[0-9]+'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Install UV
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      - name: Build Package
+        run: uv build
+
+      - name: Upload Build Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  publish-pypi:
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    needs: [build]
+    permissions:
+      id-token: write  # Required for OIDC
+      contents: read
+    steps:
+      - name: Download Build Artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.12.4
+
+  github-release:
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    needs: [build]
+    permissions:
+      contents: write
+    steps:
+      - name: Download Build Artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          tag_name: ${{ github.ref_name }}
+          name: "Release ${{ github.ref_name }}"
+          draft: false
+          prerelease: ${{ contains(github.ref_name, '-beta') || contains(github.ref_name, '-alpha') || contains(github.ref_name, '-rc') }}

.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - "**"
+  pull_request:
+    branches:
+      - "**"
+
+jobs:
+  test:
+    name: Run tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        run: uv run pytest
+        env:
+          PYTHONPATH: ./apps/

.gitignore

@@ -1,5 +1,5 @@
 # Config
-config.py
+# config.py
 
 # Virtual environment
 env/

Dockerfile.api

@@ -1,12 +1,16 @@
 FROM python:3.10-slim
-RUN pip install --upgrade pip
-RUN pip install --no-cache-dir gunicorn
-COPY requirements-api.txt /
-RUN pip install --no-cache-dir -r /requirements-api.txt
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
 
 WORKDIR /appli
+COPY pyproject.toml uv.lock ./
+RUN uv sync --frozen --no-dev
+
 COPY start.py config.py ./
 COPY apps ./apps/
 COPY templates ./templates/
+COPY tests ./tests/
+
+# Place executables in the environment at the front of the path
+ENV PATH="/appli/.venv/bin:$PATH"
 
 CMD ["/bin/bash", "-c", "gunicorn --workers 2 --timeout 600 --bind 0.0.0.0:9001 start:app"]

Dockerfile.cacher

@@ -1,10 +1,14 @@
 FROM python:3.10-slim
-RUN pip install --upgrade pip
-COPY requirements-cacher.txt /
-RUN pip install --no-cache-dir -r /requirements-cacher.txt
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
 
 WORKDIR /appli
+COPY pyproject.toml uv.lock ./
+RUN uv sync --frozen --no-dev
+
 COPY cache.py config.py ./
 COPY apps ./apps/
 
-CMD ["/bin/bash", "-c", "python3 cache.py"]
+# Place executables in the environment at the front of the path
+ENV PATH="/appli/.venv/bin:$PATH"
+
+CMD ["python", "cache.py"]

Dockerfile.worker

@@ -0,0 +1,15 @@
+FROM python:3.10-slim
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
+
+WORKDIR /appli
+COPY pyproject.toml uv.lock ./
+RUN uv sync --frozen --no-dev
+
+# Copy app code
+COPY apps ./apps/
+
+# Place executables in the environment at the front of the path
+ENV PATH="/appli/.venv/bin:$PATH"
+
+# Run the worker in daemon mode by default
+CMD ["python", "apps/worker.py", "--daemon"]

README.md

@@ -15,22 +15,9 @@ Following implementation requires MongoDB v4.2 or higher.
 ## Deployment
 
 1. Clone the [https://github.com/EIDA/ws-availability] repository and go to its root
-1. Copy `config.py.sample` to `config.py` and adjust it as needed (please notice there are two sections - `RUNMODE == "production"` and `RUNMODE == "test"`; for Docker deployment use the `production` section):
-
-    ```bash
-    # WFCatalog MongoDB
-    MONGODB_HOST = "localhost" #MongoDB host
-    MONGODB_PORT = 27017 #MongoDB port
-    MONGODB_USR = "" #MongoDB user
-    MONGODB_PWD = "" #MongoDB password
-    MONGODB_NAME = "wfrepo" #MongoDB database name
-    FDSNWS_STATION_URL = "https://orfeus-eu.org/fdsnws/station/1/query" #FDSNWS-Station endpoint to harvest restriction information from
-    CACHE_HOST = "localhost" #Cache host
-    CACHE_PORT = 6379 #Cache port
-    CACHE_INVENTORY_KEY = "inventory" #Cache key for restriction information
-    CACHE_INVENTORY_PERIOD = 0 #Cache invalidation period for `inventory` key; 0 = never invalidate
-    CACHE_RESP_PERIOD = 1200 #Cache invalidation period for API response
-    ```
+1. Configure the application using Environment Variables. You can use `config.py.sample` as a reference for available variables found in the `Config` class.
+   
+    **Note:** The application now uses a strict typed configuration system. The legacy `config.py` file is no longer loaded directly; parameters must be supplied via environment variables (which fits naturally with the Docker setup below).
 
 1. Build the containers:
 
@@ -226,23 +213,11 @@ Following implementation requires MongoDB v4.2 or higher.
 ## Running in development environment
 
 1. Go to the root directory.
-1. Copy `config.py.sample` to `config.py` and adjust it as needed.
-1. Create the virtual environment:
-
-    ```bash
-    python3 -m venv env
-    ```
-
-1. Activate the virtual environment:
-
-    ```bash
-    source env/bin/activate
-    ```
-
-1. Install the dependencies:
+1. Configure Environment Variables (e.g. by exporting them or creating a `.env` file). Reference `config.py.sample` for names.
+1. Install dependencies using `uv` (faster alternative to pip):
 
     ```bash
-    pip install -r requirements.txt
+    uv sync
     ```
 
 1. Create Redis instance (mandatory for WFCatalog-based deployment):
@@ -254,17 +229,17 @@ Following implementation requires MongoDB v4.2 or higher.
 1. Build the cache:
 
     ```bash
-    python3 cache.py
+    uv run python cache.py
     ```
 
 1. Now you can either:
     1. Run it:
 
         ```bash
-        RUNMODE=test FLASK_APP=start.py flask run
+        RUNMODE=test FLASK_APP=start.py uv run flask run --port 9001
 
         # Or with gunicorn:
-        RUNMODE=test gunicorn --workers 2 --timeout 60 --bind 0.0.0.0:9001 start:app
+        RUNMODE=test uv run gunicorn --workers 2 --timeout 60 --bind 0.0.0.0:9001 start:app
         ```
 
     1. Debug it in VS Code (F5) after selecting "Launch (Flask)" config.
@@ -279,7 +254,7 @@ Following implementation requires MongoDB v4.2 or higher.
 Tests can be executed from the respository root using following command:
 
 ```bash
-PYTHONPATH=./apps/ python3 -m unittest discover tests/
+uv run pytest
 ```
 
 ## Ideas for improvements