feat: backport CLI fixes to Python 3.6

.github/workflows/ci.yml

@@ -1,13 +1,13 @@
-name: Python package
+name: CI tests via tox
 
 on:
   push:
     branches: 
-      - "*"
+      - '**'
 
   pull_request:
     branches:
-      - "*"
+      - '**'
 
 jobs:
   build:
@@ -17,9 +17,9 @@ jobs:
         python-version: ['3.10', '3.11', '3.12']
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

.github/workflows/python-publish.yml

@@ -15,7 +15,7 @@ jobs:
         python-version: ['3.10', '3.11', '3.12']
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
@@ -35,10 +35,10 @@ jobs:
     runs-on: ubuntu-latest
     needs: test
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.x'
 
@@ -49,8 +49,7 @@ jobs:
 
     - name: Build and publish
       env:
-        TWINE_USERNAME: "__token__"
-        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
       run: |
         poetry build
         poetry publish

.github/workflows/release-please.yml

@@ -2,6 +2,7 @@ on:
   push:
     branches:
       - master
+      - 'releases/**'
 
 permissions:
   contents: write
@@ -13,22 +14,25 @@ jobs:
   release-please:
     runs-on: ubuntu-latest
     steps:
-      - uses: google-github-actions/release-please-action@v4
+      - uses: googleapis/release-please-action@v4
         id: release
         with:
           # this assumes that you have created a personal access token
           # (PAT) and configured it as a GitHub action secret named
           # `MY_RELEASE_PLEASE_TOKEN` (this secret name is not important).
           token: ${{ secrets.MY_RELEASE_PLEASE_TOKEN }}
           release-type: python
+          # The short ref name of the branch or tag that triggered
+          #  the workflow run. For example, `main` or `1.x`
+          target-branch: ${{ github.ref_name }}
 
       - uses: actions/checkout@v4
       - name: tag major and minor versions
         if: ${{ steps.release.outputs.release_created }}
         run: |
           git config user.name github-actions[bot]
           git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-          git remote add gh-token "https://${{ secrets.GITHUB_TOKEN }}@github.com/google-github-actions/release-please-action.git"
+          git remote add gh-token "https://${{ secrets.GITHUB_TOKEN }}@github.com/googleapis/release-please-action.git"
           git tag -d v${{ steps.release.outputs.major }} || true
           git tag -d v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} || true
           git push origin :v${{ steps.release.outputs.major }} || true

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "2.4.0"
+  ".": "2.5.2"
 }

.sqa/docker-compose.yml

@@ -2,7 +2,7 @@ version: "3.6"
 
 services:
   DEEPaaS-testing:
-    image: "indigodatacloud/ci-images:python3.11"
+    image: "ai4oshub/ci-images:python3.12"
     hostname: "deepaas-testing"
     volumes:
      - type: bind

README.md

@@ -2,8 +2,8 @@
 
 [![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu)
 [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9063/badge)](https://www.bestpractices.dev/projects/9063)
-[![GitHub license](https://img.shields.io/github/license/indigo-dc/DEEPaaS.svg)](https://github.com/indigo-dc/DEEPaaS/blob/master/LICENSE)
-[![GitHub release](https://img.shields.io/github/release/indigo-dc/DEEPaaS.svg)](https://github.com/indigo-dc/DEEPaaS/releases)
+[![GitHub license](https://img.shields.io/github/license/ai4os/DEEPaaS.svg)](https://github.com/ai4os/DEEPaaS/blob/master/LICENSE)
+[![GitHub release](https://img.shields.io/github/release/ai4os/DEEPaaS.svg)](https://github.com/ai4os/DEEPaaS/releases)
 [![PyPI](https://img.shields.io/pypi/v/deepaas.svg)](https://pypi.python.org/pypi/deepaas)
 [![Python versions](https://img.shields.io/pypi/pyversions/deepaas.svg)](https://pypi.python.org/pypi/deepaas)
 [![Build Status](https://jenkins.services.ai4os.eu/job/AI4OS/job/DEEPaaS/job/master/badge/icon)](https://jenkins.services.ai4os.eu/job/AI4OS/job/DEEPaaS/job/master/)

deepaas/__init__.py

@@ -14,4 +14,23 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-__version__ = "2.4.0"
+from contextlib import suppress
+# import importlib.metadata  # does not work with 3.6
+from pathlib import Path
+
+__version__ = "2.5.2"
+
+
+def extract_version() -> str:
+    """Returns either the version of the package installed."""
+    with suppress(FileNotFoundError, StopIteration):
+        root_dir = Path(__file__).parent.parent
+        with open(root_dir / "pyproject.toml", encoding="utf-8") as pyproject_toml:
+            version = (
+                next(line for line in pyproject_toml if line.startswith("version"))
+                .split("=")[1]
+                .strip("'\"\n ")
+            )
+            return f"{version}-dev (at {root_dir})"
+    # return importlib.metadata.version(__package__ or __name__.split(".", maxsplit=1)[0])
+    return __version__

deepaas/api/__init__.py

@@ -14,18 +14,19 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+import pathlib
 
 from aiohttp import web
 import aiohttp_apispec
 from oslo_config import cfg
-from oslo_log import log as logging
 
 import deepaas
 from deepaas.api import v2
 from deepaas.api import versions
+from deepaas import log
 from deepaas import model
 
-LOG = logging.getLogger(__name__)
+LOG = log.getLogger(__name__)
 
 APP = None
 
@@ -75,10 +76,22 @@ async def get_app(
     model.register_v2_models(APP)
 
     v2app = v2.get_app(enable_train=enable_train, enable_predict=enable_predict)
-    APP.add_subapp("/v2", v2app)
+    if base_path:
+        path = str(pathlib.Path(base_path) / "v2")
+    else:
+        path = "/v2"
+    APP.add_subapp(path, v2app)
     versions.register_version("stable", v2.get_version)
 
-    APP.add_routes(versions.routes)
+    if base_path:
+        # Get versions.routes, and transform them to have the base_path, as we cannot
+        # directly modify the routes already created and stored in the RouteTableDef
+        for route in versions.routes:
+            APP.router.add_route(
+                route.method, str(pathlib.Path(base_path + route.path)), route.handler
+            )
+    else:
+        APP.add_routes(versions.routes)
 
     LOG.info("Serving loaded V2 models: %s", list(model.V2_MODELS.keys()))
 
@@ -88,6 +101,10 @@ async def get_app(
             await m.warm()
 
     if swagger:
+        doc = str(pathlib.Path(base_path + doc))
+        swagger = str(pathlib.Path(base_path + "/swagger.json"))
+        static_path = str(pathlib.Path(base_path + static_path))
+
         # init docs with all parameters, usual for ApiSpec
         aiohttp_apispec.setup_aiohttp_apispec(
             app=APP,
@@ -99,9 +116,8 @@ async def get_app(
                 "description": "API documentation",
                 "url": "https://deepaas.readthedocs.org/",
             },
-            basePath=base_path,
-            version=deepaas.__version__,
-            url="/swagger.json",
+            version=deepaas.extract_version(),
+            url=swagger,
             swagger_path=doc if enable_doc else None,
             prefix=prefix,
             static_path=static_path,

deepaas/api/v2/__init__.py

@@ -17,13 +17,13 @@
 from aiohttp import web
 import aiohttp_apispec
 from oslo_config import cfg
-from oslo_log import log
 
 from deepaas.api.v2 import debug as v2_debug
 from deepaas.api.v2 import models as v2_model
 from deepaas.api.v2 import predict as v2_predict
 from deepaas.api.v2 import responses
 from deepaas.api.v2 import train as v2_train
+from deepaas import log
 
 CONF = cfg.CONF
 LOG = log.getLogger("deepaas.api.v2")

deepaas/api/v2/debug.py

@@ -23,7 +23,8 @@
 from aiohttp import web
 import aiohttp_apispec
 from oslo_config import cfg
-from oslo_log import log
+
+from deepaas import log
 
 CONF = cfg.CONF
 

deepaas/api/v2/train.py

@@ -21,12 +21,12 @@
 
 from aiohttp import web
 import aiohttp_apispec
-from oslo_log import log
 from webargs import aiohttpparser
 import webargs.core
 
 from deepaas.api.v2 import responses
 from deepaas.api.v2 import utils
+from deepaas import log
 from deepaas import model
 
 LOG = log.getLogger("deepaas.api.v2.train")

deepaas/api/versions.py

@@ -25,7 +25,7 @@
 routes = web.RouteTableDef()
 
 
-@routes.view("/")
+@routes.view("/", name="versions")
 class Versions(web.View):
     versions = {}