Update example project

.flake8

@@ -4,7 +4,3 @@
 # E501 line too long (83 > 79 characters)
 
 exclude = .git,.pycache,build,.eggs
-
-per-file-ignores =
-    ./src/actinia_example_plugin/wsgi.py: F401
-    ./tests/test_resource_base.py: F401 

.github/workflows/linting.yml

@@ -1,17 +1,13 @@
 ---
 name: Linting and code quality check
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
 
 jobs:
   lint:
     uses: mundialis/github-workflows/.github/workflows/linting.yml@main
-    # with:
-    #   # set pylint-version to empty string to skip the pylint workflow
-    #   pylint-version: ''
-    #   BASH_SEVERITY: 'warning'
-    #   VALIDATE_DOCKERFILE_HADOLINT: false
-    #   VALIDATE_JSON: false
-    #   VALIDATE_HTML: false
-    #   VALIDATE_CSS: false
-    #   VALIDATE_BASH_EXEC: false

.github/workflows/python-publish.yml

@@ -1,42 +1,13 @@
-# This workflow will upload a Python Package using Twine when a release is created
-# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-
-name: Upload Python Package
+name: Upload Python Package to test PyPI
 
 on:
   release:
     types: [published]
 
 jobs:
-  deploy:
-
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.x'
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install build
-      - name: Build package
-        run: python3 -m build --outdir build .
-      - name: Release
-        uses: softprops/action-gh-release@v2
-        if: startsWith(github.ref, 'refs/tags/')
-        with:
-          files: build/*.whl
-
-    # - name: Publish package
-    #   uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
-    #   with:
-    #     user: __token__
-    #     password: ${{ secrets.PYPI_API_TOKEN }}
+  publish-python:
+    uses: mundialis/github-workflows/.github/workflows/python-publish.yml@main
+    with:
+      test_pypi: true
+    secrets:
+      PYPI_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}

.github/workflows/test.yml

@@ -1,3 +1,5 @@
+---
+
 name: actinia tests
 
 on:
@@ -14,8 +16,6 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v4
-      # with:
-      #   path: "."
     - name: Set up Docker Buildx
       uses: docker/setup-buildx-action@v3
     - name: Replace run only unittest command

.gitignore

@@ -42,3 +42,9 @@ sdist/*
 # docker
 docker/redis_data/dump.rdb
 !docker/actinia-example-plugin-test/actinia-example-plugin-test.cfg
+
+# linting with shared config file
+.pylintrc
+.pylintrc_allowed_to_fail
+ruff-github-workflows.toml
+ruff-merged.toml

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: |
+          (?x)^(
+                .*\.ref$|
+                .*\.svg$|
+                build/|
+                dist/|
+                src/actinia_core.egg-info/
+          )
+      - id: end-of-file-fixer
+        exclude: |
+          (?x)^(
+                .*\.ref$|
+                .*\.svg$|
+                build/|
+                dist/|
+                src/actinia_core.egg-info/
+          )
+  - repo: https://github.com/mundialis/github-workflows
+    rev: 1.4.0
+    hooks:
+    - id: linting

docker/Dockerfile

@@ -1,17 +1,21 @@
-FROM mundialis/actinia-core:latest
+FROM mundialis/actinia-core:5.0.0
 
 # pwgen is needed for the tests
-RUN pip3 install pwgen
+RUN pip3 install --no-cache-dir pwgen==0.8.2.post0
 
 COPY docker/actinia.cfg /etc/default/actinia
 COPY src /src/actinia-example-plugin/src/
 COPY setup.cfg /src/actinia-example-plugin/
 COPY setup.py /src/actinia-example-plugin/
 COPY requirements.txt /src/actinia-example-plugin/
 
-RUN pip3 install -r /src/actinia-example-plugin/requirements.txt
-RUN pip3 uninstall actinia-example-plugin.wsgi -y
+RUN pip3 install --no-cache-dir -r /src/actinia-example-plugin/requirements.txt && \
+    pip3 uninstall actinia-example-plugin.wsgi -y
 # SETUPTOOLS_SCM_PRETEND_VERSION is only needed if in the plugin folder is no
 # .git folder
 ENV SETUPTOOLS_SCM_PRETEND_VERSION=0.0
-RUN (cd /src/actinia-example-plugin && python3 setup.py install)
+
+WORKDIR /src/actinia-example-plugin
+RUN python3 setup.py install
+
+WORKDIR /src/actinia_core

docker/actinia-example-plugin-test/Dockerfile

@@ -1,16 +1,16 @@
-FROM mundialis/actinia-core:latest as actinia_test
+FROM mundialis/actinia-core:5.0.0 as actinia_test
 
 LABEL authors="Carmen Tawalika,Anika Weinmann"
 LABEL maintainer="[email protected],[email protected]"
 
-ENV ACTINIA_CUSTOM_TEST_CFG /etc/default/actinia-example-plugin-test
+ENV ACTINIA_CUSTOM_TEST_CFG=/etc/default/actinia-example-plugin-test
 
 # TODO do not set DEFAULT_CONFIG_PATH if this is fixed
-ENV DEFAULT_CONFIG_PATH /etc/default/actinia-example-plugin-test
+ENV DEFAULT_CONFIG_PATH=/etc/default/actinia-example-plugin-test
 
 # install things only for tests
-RUN apk add redis
-RUN pip3 install iniconfig colorlog pwgen
+RUN apk add --no-cache redis==7.0.15-r1 && \
+    pip3 install --no-cache-dir iniconfig==2.0.0 colorlog==6.8.2 pwgen==0.8.2.post0
 
 # COPY docker/actinia-example-plugin-test/start.sh /src/start.sh
 
@@ -31,7 +31,6 @@ COPY . /src/actinia-example-plugin/
 
 WORKDIR /src/actinia-example-plugin/
 
-RUN chmod a+x tests_with_redis.sh
-RUN make install
+RUN chmod a+x tests_with_redis.sh && make install
 
 # RUN make test

pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires      = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "actinia-example-plugin"
+version = "1.0.0"
+description = "An actinia-core plugin which adds example endpoints to actinia-core"
+readme = "README.md"
+authors = [
+    { name = "Carmen Tawalika"},
+    { name = "Anika Weinmann"},
+]
+classifiers = [
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+]
+requires-python = ">=3.8"
+keywords = [
+    "processing",
+    "earth observation",
+    "cloud-based processing",
+    "rest api",
+    "gis",
+    "grass gis",
+    "osgeo",
+    "example",
+]
+dependencies = [
+    "colorlog>=4.2.1",
+    "xmltodict",
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "pytest-cov",
+]
+
+[project.urls]
+Homepage = "https://github.com/mundialis/actinia-example-plugin"
+Tutorial = "https://mundialis.github.io/actinia_core"
+API_Docs = "https://redocly.github.io/redoc/?url=https://actinia.mundialis.de/latest/swagger.json"
+
+[tool.flake8]
+max-line-length = 79
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "--cov actinia_module_plugin --cov-report term-missing --verbose --tb=line -x -s"
+testpaths = [
+    "tests",
+]
+markers = [
+    "dev: test current in development",
+    "unittest: completely independent test",
+    "integrationtest: integration test",
+]

renovate.json

@@ -1,6 +1,9 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
-    "config:base"
-  ]
+    "config:recommended"
+  ],
+  "pre-commit": {
+    "enabled": true
+  }
 }

ruff.toml

@@ -0,0 +1,4 @@
+lint.ignore = ["PLR0913", "PLR0917", "PLW0603", "S107", "S606"]
+
+[lint.per-file-ignores]
+"tests/testsuite.py" = [ "PLC0415",]