Port over to fastapi #519

.flake8

@@ -3,7 +3,7 @@
 select = A,B,B9,BLK,C,E,F,I,N,S,W
 ignore = E203,W503,E501
 max-complexity = 17
-max-line-length = 80
+max-line-length = 120
 application-import-names = datagateway_api,test,util
 import-order-style = google
 per-file-ignores =

.github/workflows/ci-build.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
         with:
-          python-version: "3.10"
+          python-version: "3.11"
           architecture: x64
 
       - name: Checkout DataGateway API
@@ -53,7 +53,8 @@ jobs:
         run: cp datagateway_api/config.yaml.example datagateway_api/config.yaml
       - name: Create search_api_mapping.json
         run: cp datagateway_api/search_api_mapping.json.example datagateway_api/search_api_mapping.json
-
+      - name: Create logging.ini
+        run: cp datagateway_api/logging.example.ini datagateway_api/logging.ini
       # Run Unit tests
       - name: Run Nox unit tests session
         run: nox -s unit_tests -- --cov=datagateway_api --cov-report=xml
@@ -123,6 +124,8 @@ jobs:
         run: cp datagateway_api/config.yaml.example datagateway_api/config.yaml
       - name: Create search_api_mapping.json
         run: cp datagateway_api/search_api_mapping.json.example datagateway_api/search_api_mapping.json
+      - name: Create logging.ini
+        run: cp datagateway_api/logging.example.ini datagateway_api/logging.ini
 
       - name: Install dependencies
         run: poetry install
@@ -143,7 +146,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
         with:
-          python-version: "3.10.4"
+          python-version: "3.11.13"
           architecture: x64
       - name: Checkout DataGateway API
         uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
@@ -163,7 +166,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
         with:
-          python-version: "3.10.4"
+          python-version: "3.11.13"
           architecture: x64
       - name: Checkout DataGateway API
         uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
@@ -183,7 +186,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
         with:
-          python-version: "3.10.4"
+          python-version: "3.11.13"
           architecture: x64
       - name: Checkout DataGateway API
         uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
@@ -213,7 +216,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
         with:
-          python-version: "3.10.4"
+          python-version: "3.11.13"
           architecture: x64
 
       # ICAT Ansible clone and install dependencies
@@ -260,6 +263,8 @@ jobs:
         run: cd /home/runner/work/datagateway-api/datagateway-api; cp datagateway_api/config.yaml.example datagateway_api/config.yaml
       - name: Create search_api_mapping.json
         run: cd /home/runner/work/datagateway-api/datagateway-api; cp datagateway_api/search_api_mapping.json.example datagateway_api/search_api_mapping.json
+      - name: Create logging.ini
+        run: cd /home/runner/work/datagateway-api/datagateway-api; cp datagateway_api/logging.example.ini datagateway_api/logging.ini
       - name: Install Poetry
         run: pip install poetry==1.8.0
       # This fixes the issue with cachecontrol (https://github.com/psf/cachecontrol/issues/292).
@@ -321,7 +326,8 @@ jobs:
         run: cd /home/runner/work/datagateway-api/datagateway-api; cp datagateway_api/config.yaml.example datagateway_api/config.yaml
       - name: Create search_api_mapping.json
         run: cd /home/runner/work/datagateway-api/datagateway-api; cp datagateway_api/search_api_mapping.json.example datagateway_api/search_api_mapping.json
-
+      - name: Create logging.ini
+        run: cd /home/runner/work/datagateway-api/datagateway-api; cp datagateway_api/logging.example.ini datagateway_api/logging.ini
       - name: Install dependencies
         run: poetry install
 
@@ -355,11 +361,13 @@ jobs:
       # Checkout DataGateway API and setup Python
       - name: Check out repo
         uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v3.5.3
+      - name: Add apt repo
+        run: sudo add-apt-repository universe
       # Setup Java & Python
       - name: Setup Python
         uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
         with:
-          python-version: "3.10"
+          python-version: "3.11"
           architecture: x64
       - name: Setup Java
         uses: actions/setup-java@b36c23c0d998641eff861008f374ee103c25ac73 # v4.4.0
@@ -436,6 +444,8 @@ jobs:
         run: cp datagateway_api/config.yaml.example datagateway_api/config.yaml
       - name: Create search_api_mapping.json
         run: cp datagateway_api/search_api_mapping.json.example datagateway_api/search_api_mapping.json
+      - name: Create logging.ini
+        run: cp datagateway_api/logging.example.ini datagateway_api/logging.ini
 
       # Launch API to see if it starts correctly or has a startup issue
       # Code logic used from https://stackoverflow.com/a/63643845

.gitignore

@@ -10,3 +10,5 @@ search_api_mapping.json*
 .python-version
 .coverage
 coverage.xml
+
+datagateway_api/logging.ini

Dockerfile

@@ -1,7 +1,7 @@
 # Dockerfile to build and serve datagateway-api
 
 # Build stage
-FROM python:3.11-alpine3.17 as builder
+FROM python:3.11-alpine3.17 AS builder
 
 WORKDIR /datagateway-api-build
 
@@ -11,7 +11,7 @@ COPY datagateway_api/ datagateway_api/
 RUN --mount=type=cache,target=/root/.cache \
     set -eux; \
     \
-    python3 -m pip install 'poetry~=1.3.2'; \
+    python3 -m pip install 'poetry~=1.8.0'; \
     poetry build;
 
 
@@ -26,7 +26,6 @@ RUN --mount=type=cache,target=/root/.cache \
     set -eux; \
     \
     python3 -m pip install \
-        'gunicorn~=20.1.0' \
         /tmp/datagateway_api-*.whl; \
     \
     # Create a symlink to the installed python module \
@@ -36,6 +35,7 @@ RUN --mount=type=cache,target=/root/.cache \
     # Create config.yaml and search_api_mapping.json from their .example files \
     cp datagateway_api/config.yaml.example datagateway_api/config.yaml; \
     cp datagateway_api/search_api_mapping.json.example datagateway_api/search_api_mapping.json; \
+    cp datagateway_api/logging.example.ini datagateway_api/logging.ini; \
     \
     # Create a non-root user to run as \
     addgroup -S datagateway-api; \
@@ -53,6 +53,7 @@ ENV LOG_LOCATION="/dev/stdout"
 COPY docker/docker-entrypoint.sh /usr/local/bin/
 ENTRYPOINT ["docker-entrypoint.sh"]
 
-# Serve the application using gunicorn - production ready WSGI server
-CMD ["gunicorn", "-b", "0.0.0.0:8000", "datagateway_api.wsgi"]
+
+CMD ["fastapi", "dev", "datagateway_api/src/main.py", "--host", "0.0.0.0", "--port", "8000"]
+
 EXPOSE 8000

datagateway_api/config.yaml.example

@@ -24,7 +24,6 @@ search_api:
     api_request_timeout: 5
     group: "documents" #corresponds to the defined group in the scoring app. https://github.com/panosc-eu/panosc-search-scoring/blob/master/docs/md/PaNOSC_Federated_Search_Results_Scoring_API.md#model
     limit: 1000
-flask_reloader: false
 log_level: "DEBUG"
 log_location: "/home/runner/work/datagateway/datagateway/datagateway-api/datagateway_api/logs.log"
 debug_mode: true

datagateway_api/logging.example.ini

@@ -0,0 +1,28 @@
+[loggers]
+keys=root,uvicorn.access
+
+[handlers]
+keys=consoleHandler
+
+[formatters]
+keys=consoleFormatter
+
+[logger_root]
+level=DEBUG
+handlers=consoleHandler
+qualname=root
+propagate=0
+
+[logger_uvicorn.access]
+level=INFO
+handlers=consoleHandler
+qualname=uvicorn.access
+propagate=0
+
+[handler_consoleHandler]
+class=StreamHandler
+formatter=consoleFormatter
+args=(sys.stdout,)
+
+[formatter_consoleFormatter]
+format=[%(asctime)s]  %(module)s:%(filename)s:%(funcName)s:%(lineno)d  %(levelname)s - %(message)s