release v0.12.0

* move check_manifest configuration to setup.cfg

* remove upper constraint for pytest-black

.github/workflows/pypi-publish.yml

@@ -5,22 +5,5 @@ on:
 
 jobs:
   build-n-publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.7
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.7
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install setuptools wheel "babel<=2.9.1"
-      - name: Build package
-        run: |
-          python setup.py compile_catalog sdist bdist_wheel
-      - name: pypi-publish
-        uses: pypa/gh-action-pypi-publish@v1.3.1
-        with:
-          user: __token__
-          password: ${{ secrets.pypi_password }}
+    uses: tu-graz-library/.github/.github/workflows/pypi-publish.yml@main
+    secrets: inherit

.github/workflows/tests.yml

@@ -16,51 +16,5 @@ on:
         default: 'Manual trigger'
 
 jobs:
-  Tests:
-    runs-on: ubuntu-20.04
-    strategy:
-      matrix:
-          python-version: [3.8, 3.9]
-          requirements-level: [pypi]
-          db-service: [postgresql13]
-          search-service: [elasticsearch7]
-          include:
-          - db-service: postgresql13
-            DB_EXTRAS: "postgresql"
-
-          - search-service: elasticsearch7
-            SEARCH_EXTRAS: "elasticsearch7"
-
-    env:
-      DB: ${{ matrix.db-service }}
-      SEARCH: ${{ matrix.search-service }}
-      EXTRAS: tests,${{ matrix.SEARCH_EXTRAS }}
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Generate dependencies
-        run: |
-          pip install wheel requirements-builder
-          requirements-builder -e "$EXTRAS" --level=${{ matrix.requirements-level }} setup.py > .${{ matrix.requirements-level }}-${{ matrix.python-version }}-requirements.txt
-      - name: Cache pip
-        uses: actions/cache@v2
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('.${{ matrix.requirements-level }}-${{ matrix.python-version }}-requirements.txt') }}
-
-      - name: Install dependencies
-        run: |
-          pip install -r .${{ matrix.requirements-level }}-${{ matrix.python-version }}-requirements.txt
-          pip install ".[$EXTRAS]"
-          pip freeze
-          docker --version
-          docker-compose --version
-      - name: Run tests
-        run: |
-          ./run-tests.sh
+  tests:
+    uses: tu-graz-library/.github/.github/workflows/tests.yml@main

CHANGES.rst

@@ -7,6 +7,37 @@
 
 Changes
 =======
+
+Version v0.12.0 (release 2023-11-10)
+
+- setup: remove python3.8 support
+- global: make it compatible with v12
+
+
+Version v0.11.0 (release 2023-04-20)
+
+- global: make package compatible with v11
+
+
+Version v0.10.4 (release 2023-02-10)
+
+
+
+
+Version v0.10.2 (release 2023-02-02)
+
+- change version name
+- footer: update guid
+
+
+Version v0.10.1 (release 2022-11-17)
+
+- global: add function
+
+Version 0.10.0 (released 2022-10-13)
+
+- global: migrate to v10 (#101)
+
 Version 0.9.1 (released 2022-05-30)
 
 - ci(publish): ping babel version (#99)

babel.ini

@@ -15,7 +15,6 @@ encoding = utf-8
 
 [jinja2: **/templates/**.*]
 encoding = utf-8
-extensions = jinja2.ext.autoescape, jinja2.ext.with_
 
 # Extraction from JavaScript files
 

docs/conf.py

@@ -64,7 +64,7 @@ release = __version__
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

invenio_config_tugraz/__init__.py

@@ -10,7 +10,13 @@
 
 from .ext import InvenioConfigTugraz
 from .generators import RecordIp
+from .utils import get_identity_from_user_by_email
 
-__version__ = "0.9.1"
+__version__ = "0.12.0"
 
-__all__ = ("__version__", "InvenioConfigTugraz", "RecordIp")
+__all__ = (
+    "__version__",
+    "InvenioConfigTugraz",
+    "RecordIp",
+    "get_identity_from_user_by_email",
+)

invenio_config_tugraz/config.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020-2022 Graz University of Technology.
+# Copyright (C) 2020-2023 Graz University of Technology.
 #
 # invenio-config-tugraz is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
@@ -8,7 +8,7 @@
 
 """invenio module that adds tugraz configs."""
 
-from flask_babelex import gettext as _
+from invenio_i18n import gettext as _
 
 INVENIO_CONFIG_TUGRAZ_SHIBBOLETH = False
 """Set True if SAML is configured"""

invenio_config_tugraz/generators.py

@@ -151,10 +151,10 @@ The succinct encoding of the permissions for your instance gives you
     - great flexibility by defining your own actions, generators and policies
 """
 
-from elasticsearch_dsl.query import Q
 from flask import current_app, request
 from invenio_access.permissions import any_user
 from invenio_records_permissions.generators import Generator
+from invenio_search.engine import dsl
 
 
 class RecordIp(Generator):
@@ -208,10 +208,10 @@ class RecordIp(Generator):
 
         if not visible:
             # If user ip is not on the list, and If the record contains 'singleip' will not be seen
-            return ~Q("match", **{"access.access_right": "singleip"})
+            return ~dsl.Q("match", **{"access.access_right": "singleip"})
 
         # Lists all records
-        return Q("match_all")
+        return dsl.Q("match_all")
 
     def check_permission(self):
         """Check for User IP address in config variable."""

invenio_config_tugraz/utils.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 Graz University of Technology.
+#
+# invenio-config-tugraz is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Utils file."""
+
+from flask_principal import Identity
+from invenio_access import any_user
+from invenio_access.utils import get_identity
+from invenio_accounts import current_accounts
+
+
+def get_identity_from_user_by_email(email: str = None) -> Identity:
+    """Get the user specified via email or ID."""
+    if email is None:
+        raise ValueError("the email has to be set to get a identity")
+
+    user = current_accounts.datastore.get_user(email)
+
+    if user is None:
+        raise LookupError(f"user with {email} not found")
+
+    identity = get_identity(user)
+
+    # TODO: this is a temporary solution. this should be done with data from the db
+    identity.provides.add(any_user)
+
+    return identity

invenio_config_tugraz/views.py

@@ -9,7 +9,7 @@
 """invenio module for TUGRAZ config."""
 
 from flask import Blueprint, current_app, redirect, url_for
-from flask_babelex import get_locale
+from invenio_i18n import get_locale
 
 
 def ui_blueprint(app):
@@ -51,7 +51,7 @@ def guide():
     return redirect(
         url_for(
             "static",
-            filename=f"documents/TUGraz_Repository_Guide_02_{locale}.pdf",
+            filename=f"documents/TUGraz_Repository_Guide_02.1_{locale}.pdf",
             _external=True,
         )
     )

run-tests.sh

@@ -23,7 +23,7 @@ function cleanup() {
 }
 trap cleanup EXIT
 
-python -m check_manifest --ignore ".*-requirements.txt"
+python -m check_manifest
 python -m sphinx.cmd.build -qnN docs docs/_build/html
 eval "$(docker-services-cli up --search ${SEARCH:-elasticsearch} --env)"
 python -m pytest

setup.cfg

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020-2022 Graz University of Technology.
+# Copyright (C) 2020-2023 Graz University of Technology.
 #
 # invenio-config-tugraz is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
@@ -25,28 +25,27 @@ classifiers =
     Programming Language :: Python
     Topic :: Internet :: WWW/HTTP :: Dynamic Content
     Topic :: Software Development :: Libraries :: Python Modules
-    Programming Language :: Python :: 3.7
-    Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
     Development Status :: 3 - Alpha
 
 [options]
 include_package_data = True
 packages = find:
-python_requires = >=3.8
+python_requires = >=3.9
 zip_safe = False
 install_requires =
     # keep this dependencies identical to invenio-app-rdm
-    invenio-rdm-records>=0.35.16,<0.36.0
-    invenio-cache>=1.1.1,<1.2.0
+    invenio-cache>=1.1.1,<2.0.0
+    invenio-i18n>=2.0.0,<3.0.0
+    invenio-rdm-records>=4.0.0,<5.0.0
 
 [options.extras_require]
 tests =
-    pytest-black>=0.3.0,<0.3.10
-    sphinx>=4.2.0,<5
-    pytest-invenio>=1.4.7
-elasticsearch7 =
-    invenio-search[elasticsearch7]>=1.4.2,<2.0
+    pytest-black>=0.3.0
+    pytest-invenio>=2.1.0,<3.0.0
+    invenio-search[opensearch2]>=2.1.0,<3.0.0
+    Sphinx>=4.5.0
 
 [options.entry_points]
 invenio_base.apps =
@@ -93,6 +92,10 @@ output-dir = invenio_config_tugraz/translations/
 [isort]
 profile=black
 
+[check-manifest]
+ignore =
+    *-requirements.txt
+
 [tool:pytest]
 addopts = --black --isort --pydocstyle --doctest-glob="*.rst" --doctest-modules --cov=invenio_config_tugraz --cov-report=term-missing tests invenio_config_tugraz
 testpaths = tests invenio_config_tugraz

tests/conftest.py

@@ -18,8 +18,8 @@ import tempfile
 
 import pytest
 from flask import Flask
-from flask_babelex import Babel
 from invenio_db import InvenioDB, db
+from invenio_i18n import InvenioI18N
 from sqlalchemy_utils.functions import create_database, database_exists, drop_database
 
 from invenio_config_tugraz import InvenioConfigTugraz
@@ -49,7 +49,7 @@ def create_app(request):
         SQLALCHEMY_DATABASE_URI=DB,
         SQLALCHEMY_TRACK_MODIFICATIONS=False,
     )
-    Babel(app)
+    InvenioI18N(app)
     InvenioConfigTugraz(app)
     InvenioDB(app)