Merge pull request #29 from ecmwf/feature/rest-fastapi

Feature/rest fastapi

.github/workflows/check-publish.yml

@@ -15,9 +15,9 @@ on:
 jobs:
   quality:
     name: Code QA
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - run: pip install black flake8 isort
       - run: black --version
       - run: isort --check .
@@ -28,16 +28,16 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        platform: ["ubuntu-20.04", "macos-13"]
-        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10", "3.11"]
+        platform: ["ubuntu-latest", "macos-13"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     name: Python ${{ matrix.python-version }} on ${{ matrix.platform }}
     runs-on: ${{ matrix.platform }}
     needs: quality
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -75,18 +75,18 @@ jobs:
           pip install -r docs/requirements.txt
 
       - name: Tests on Ubuntu
-        if: matrix.platform == 'ubuntu-20.04'
         run: |
           pip freeze
           pytest
+        if: runner.os == 'Linux'
         env:
           AVISO_DEBUG: True
 
       - name: Tests on macOS
-        if: matrix.platform == 'macos-13'
         run: |
           pip freeze
           pytest -v --cov=pyaviso --cache-clear
+        if: runner.os == 'macOS'
         env:
           AVISO_DEBUG: True
 
@@ -105,9 +105,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
           python-version: "3.8"
 

.github/workflows/check.yaml

@@ -13,7 +13,7 @@ jobs:
     name: Code QA
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - run: pip install black flake8 isort
       - run: black --version
       - run: isort --check .
@@ -24,16 +24,16 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        platform: ["ubuntu-20.04","macos-13"]
-        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10", "3.11"]
+        platform: ["ubuntu-latest","macos-13"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     name: Python ${{ matrix.python-version }} on ${{ matrix.platform }}
     runs-on: ${{ matrix.platform }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python-version }}
 

aviso-server/rest/README.md

@@ -1,19 +1,18 @@
 # Aviso Rest
 
 This component is a REST frontend that allows notification providers to submit notifications to the Aviso service 
-via REST. Internally it uses Aviso API as if it was a client towards the store.
+via REST. Internally it uses Aviso API as if it is a client towards the notification store.
 
-Install it by, from the main project directory:
+Run the following commands in the main project directory to install aviso-rest:
 ```
  % pip install -e .
  % pip install -e aviso-server/monitoring
  % pip install -e aviso-server/rest
 ```
 The aviso and aviso-monitoring packages are required by aviso-rest.
 
-Launch it by:
+Aviso rest can be launched by:
 
 ```
 % aviso-rest
-```
-
+```

aviso-server/rest/aviso_rest/__init__.py

@@ -9,7 +9,7 @@
 import logging
 
 # version number for the application.
-__version__ = "0.4.0"
+__version__ = "0.5.0"
 
 # setting application logger
 logger = logging.getLogger("aviso-rest")

aviso-server/rest/aviso_rest/config.py

@@ -42,7 +42,6 @@ def __init__(
         host=None,
         port=None,
         server_type=None,
-        workers=None,
         aviso=None,
         monitoring=None,
         skips=None,
@@ -73,7 +72,6 @@ def __init__(
             self.host = host
             self.port = port
             self.server_type = server_type
-            self.workers = workers
             self.aviso = aviso
             self.monitoring = monitoring
             self.skips = skips
@@ -94,8 +92,7 @@ def _create_default_config() -> Dict:
         config["debug"] = False
         config["host"] = "127.0.0.1"
         config["port"] = 8080
-        config["server_type"] = "flask"
-        config["workers"] = "1"
+        config["server_type"] = "uvicorn"
         config["skips"] = {}
         return config
 
@@ -159,8 +156,6 @@ def _read_env_variables(self) -> Dict[str, any]:
             config["port"] = int(os.environ["AVISO_REST_PORT"])
         if "AVISO_REST_SERVER_TYPE" in os.environ:
             config["server_type"] = os.environ["AVISO_REST_SERVER_TYPE"]
-        if "AVISO_REST_WORKERS" in os.environ:
-            config["workers"] = int(os.environ["AVISO_REST_WORKERS"])
         return config
 
     def logging_setup(self, logging_conf_path: str):
@@ -250,14 +245,6 @@ def server_type(self):
     def server_type(self, server_type: str):
         self._server_type = self._configure_property(server_type, "server_type")
 
-    @property
-    def workers(self):
-        return self._workers
-
-    @workers.setter
-    def workers(self, workers: int):
-        self._workers = self._configure_property(workers, "workers")
-
     @property
     def debug(self) -> bool:
         return self._debug
@@ -293,7 +280,6 @@ def __str__(self):
             + f", port: {self.port}"
             + f", server_type: {self.server_type}"
             + f", debug: {self.debug}"
-            + f", workers: {self.workers}"
             + f", aviso: {self.aviso}"
             + f", monitoring: {self.monitoring}"
             + f", skips: {self.skips}"