invenio-banners 3.2.0__tar.gz → 3.3.0__tar.gz

invenio_banners-3.3.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,11 @@
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build-n-publish:
+    uses: inveniosoftware/workflows/.github/workflows/pypi-publish.yml@master
+    secrets: inherit
+    with:
+      babel-compile-catalog: true

{invenio-banners-3.2.0 → invenio_banners-3.3.0}/.github/workflows/tests.yml

@@ -10,9 +10,13 @@ name: CI
 
 on:
   push:
-    branches: master
+    branches: 
+      - master
+      - maint-v3.x
   pull_request:
-    branches: master
+    branches:
+      - master
+      - maint-v3.x
   schedule:
     # * is a special character in YAML so you have to quote this string
     - cron:  "0 3 * * 6"

{invenio-banners-3.2.0 → invenio_banners-3.3.0}/CHANGES.rst

@@ -7,6 +7,10 @@
 Changes
 =======
 
+Version v3.3.0 (released 2025-01-22)
+
+- templates: pass ui classes through macro parameters
+
 Version v3.2.0 (released 2024-11-05)
 
 - feat(administration): use html editor for message

invenio_banners-3.3.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.2
+Name: invenio-banners
+Version: 3.3.0
+Summary: Invenio-Banners is a module used to create and show banners with useful messages to users.
+Home-page: https://github.com/inveniosoftware/invenio-banners
+Author: CERN
+Author-email: info@inveniosoftware.org
+License: MIT
+Keywords: Invenio Banners
+Platform: any
+Classifier: Development Status :: 1 - Planning
+Requires-Python: >=3.7
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: invenio-i18n<3.0.0,>=2.0.0
+Requires-Dist: invenio-administration<3.0.0,>=2.0.0
+Provides-Extra: tests
+Requires-Dist: pytest-invenio<3.0.0,>=2.1.0; extra == "tests"
+Requires-Dist: invenio-app<2.0.0,>=1.3.4; extra == "tests"
+Requires-Dist: pytest-black>=0.3.0; extra == "tests"
+Requires-Dist: sphinx>=4.5; extra == "tests"
+Provides-Extra: opensearch1
+Requires-Dist: invenio-search[opensearch1]<3.0.0,>=2.1.0; extra == "opensearch1"
+Provides-Extra: opensearch2
+Requires-Dist: invenio-search[opensearch2]<3.0.0,>=2.1.0; extra == "opensearch2"
+
+..
+    Copyright (C) 2020 CERN.
+
+    Invenio-Banners is free software; you can redistribute it and/or modify
+    it under the terms of the MIT License; see LICENSE file for more details.
+
+=================
+ Invenio-Banners
+=================
+
+.. image:: https://img.shields.io/travis/inveniosoftware/invenio-banners.svg
+        :target: https://travis-ci.org/inveniosoftware/invenio-banners
+
+.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-banners.svg
+        :target: https://coveralls.io/r/inveniosoftware/invenio-banners
+
+.. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-banners.svg
+        :target: https://github.com/inveniosoftware/invenio-banners/releases
+
+.. image:: https://img.shields.io/pypi/dm/invenio-banners.svg
+        :target: https://pypi.python.org/pypi/invenio-banners
+
+.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-banners.svg
+        :target: https://github.com/inveniosoftware/invenio-banners/blob/master/LICENSE
+
+Create and show banners with useful messages to users.
+
+Further documentation is available on
+https://invenio-banners.readthedocs.io/
+
+..
+    Copyright (C) 2020-2024 CERN.
+
+    Invenio-Banners is free software; you can redistribute it and/or modify
+    it under the terms of the MIT License; see LICENSE file for more details.
+
+Changes
+=======
+
+Version v3.3.0 (released 2025-01-22)
+
+- templates: pass ui classes through macro parameters
+
+Version v3.2.0 (released 2024-11-05)
+
+- feat(administration): use html editor for message
+- global: change the code to be compatible with sqlalchemy >= 2.0
+- global: add compatibility layer to move to flask >= 3.0
+
+Version v3.1.0 (released 2024-08-07)
+
+- http headers: use and adjust vnd.inveniordm.v1+json http accept header
+
+Version 3.0.2 (released 2024-07-17)
+
+- errors: implement REST validation error for banner loader
+
+Version 3.0.1 (released 2024-02-21)
+
+- Moved admin menu item for banners to site administration category
+
+Version 3.0.0 (released 2024-01-31)
+
+- installation: bump invenio-administration
+
+Version 2.1.1 (released 2023-07-24)
+
+- ui: remove bottom margin
+
+Version 2.1.0 (released 2023-03-02)
+
+- remove deprecated flask-babelex imports
+- install invenio-i18n explicitly
+
+Version 2.0.0 (released 2023-02-15)
+
+- global: refactor into resource/service pattern
+- global: implement CRUD operations
+- global: implement best practices for packaging (declarative cfg), code
+  linting (black) and testing
+- search: improve banners search by query params
+- administration: integrate banners view module
+
+
+Version 1.0.0a1 (release 2020-10-25)
+------------------------------------
+
+- Initial public release.

{invenio-banners-3.2.0 → invenio_banners-3.3.0}/invenio_banners/__init__.py

@@ -10,6 +10,6 @@
 
 from .ext import InvenioBanners
 
-__version__ = "3.2.0"
+__version__ = "3.3.0"
 
 __all__ = ("__version__", "InvenioBanners")

{invenio-banners-3.2.0 → invenio_banners-3.3.0}/invenio_banners/templates/semantic-ui/invenio_banners/banner.html

@@ -7,12 +7,15 @@
   under the terms of the MIT License; see LICENSE file for more details.
 #}
 
-{%- macro banner() -%}
+{%- macro banner(ui_classes) -%}
   {%- block banner %}
     {%- set banners = get_active_banners() %}
+    {% if not ui_classes %}
+      {% set ui_classes = "top attached m-0" %}
+    {% endif %}
     {% if banners %}
       {% for banner in banners %}
-        <div class="{{ banner.category|style_banner_category }}">
+        <div class="ui {{ banner.category|style_banner_category }} message {{ ui_classes }} inv-banner" id="banner-{{ banner.id }}">
           <div class="ui container">
               {{ banner.message|safe }}
           </div>

{invenio-banners-3.2.0 → invenio_banners-3.3.0}/invenio_banners/utils.py

@@ -20,7 +20,7 @@ def get_active_banners_for_request():
 
 def style_category(category):
     """Return predefined Semantic-UI classes for each banner category."""
-    style_class = "ui {} flashed top attached manage m-0 message"
+    style_class = "{}"
     if category == "warning":
         style_class = style_class.format("warning")
     elif category == "other":

invenio_banners-3.3.0/invenio_banners.egg-info/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.2
+Name: invenio-banners
+Version: 3.3.0
+Summary: Invenio-Banners is a module used to create and show banners with useful messages to users.
+Home-page: https://github.com/inveniosoftware/invenio-banners
+Author: CERN
+Author-email: info@inveniosoftware.org
+License: MIT
+Keywords: Invenio Banners
+Platform: any
+Classifier: Development Status :: 1 - Planning
+Requires-Python: >=3.7
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: invenio-i18n<3.0.0,>=2.0.0
+Requires-Dist: invenio-administration<3.0.0,>=2.0.0
+Provides-Extra: tests
+Requires-Dist: pytest-invenio<3.0.0,>=2.1.0; extra == "tests"
+Requires-Dist: invenio-app<2.0.0,>=1.3.4; extra == "tests"
+Requires-Dist: pytest-black>=0.3.0; extra == "tests"
+Requires-Dist: sphinx>=4.5; extra == "tests"
+Provides-Extra: opensearch1
+Requires-Dist: invenio-search[opensearch1]<3.0.0,>=2.1.0; extra == "opensearch1"
+Provides-Extra: opensearch2
+Requires-Dist: invenio-search[opensearch2]<3.0.0,>=2.1.0; extra == "opensearch2"
+
+..
+    Copyright (C) 2020 CERN.
+
+    Invenio-Banners is free software; you can redistribute it and/or modify
+    it under the terms of the MIT License; see LICENSE file for more details.
+
+=================
+ Invenio-Banners
+=================
+
+.. image:: https://img.shields.io/travis/inveniosoftware/invenio-banners.svg
+        :target: https://travis-ci.org/inveniosoftware/invenio-banners
+
+.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-banners.svg
+        :target: https://coveralls.io/r/inveniosoftware/invenio-banners
+
+.. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-banners.svg
+        :target: https://github.com/inveniosoftware/invenio-banners/releases
+
+.. image:: https://img.shields.io/pypi/dm/invenio-banners.svg
+        :target: https://pypi.python.org/pypi/invenio-banners
+
+.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-banners.svg
+        :target: https://github.com/inveniosoftware/invenio-banners/blob/master/LICENSE
+
+Create and show banners with useful messages to users.
+
+Further documentation is available on
+https://invenio-banners.readthedocs.io/
+
+..
+    Copyright (C) 2020-2024 CERN.
+
+    Invenio-Banners is free software; you can redistribute it and/or modify
+    it under the terms of the MIT License; see LICENSE file for more details.
+
+Changes
+=======
+
+Version v3.3.0 (released 2025-01-22)
+
+- templates: pass ui classes through macro parameters
+
+Version v3.2.0 (released 2024-11-05)
+
+- feat(administration): use html editor for message
+- global: change the code to be compatible with sqlalchemy >= 2.0
+- global: add compatibility layer to move to flask >= 3.0
+
+Version v3.1.0 (released 2024-08-07)
+
+- http headers: use and adjust vnd.inveniordm.v1+json http accept header
+
+Version 3.0.2 (released 2024-07-17)
+
+- errors: implement REST validation error for banner loader
+
+Version 3.0.1 (released 2024-02-21)
+
+- Moved admin menu item for banners to site administration category
+
+Version 3.0.0 (released 2024-01-31)
+
+- installation: bump invenio-administration
+
+Version 2.1.1 (released 2023-07-24)
+
+- ui: remove bottom margin
+
+Version 2.1.0 (released 2023-03-02)
+
+- remove deprecated flask-babelex imports
+- install invenio-i18n explicitly
+
+Version 2.0.0 (released 2023-02-15)
+
+- global: refactor into resource/service pattern
+- global: implement CRUD operations
+- global: implement best practices for packaging (declarative cfg), code
+  linting (black) and testing
+- search: improve banners search by query params
+- administration: integrate banners view module
+
+
+Version 1.0.0a1 (release 2020-10-25)
+------------------------------------
+
+- Initial public release.

{invenio-banners-3.2.0 → invenio_banners-3.3.0}/invenio_banners.egg-info/entry_points.txt

@@ -18,4 +18,3 @@ invenio_banners = invenio_banners:alembic
 
 [invenio_db.models]
 invenio_banners = invenio_banners.records.models
-

{invenio-banners-3.2.0 → invenio_banners-3.3.0}/tests/test_macro.py

@@ -51,19 +51,18 @@ def test_jinja_macro(app, db):
     # add one banner
     EXPECTED_MSG = "Test banner info message"
     EXPECTED_CATEGORY = "info"
-    EXPECTED_STYLE = "ui info flashed top attached manage m-0 message"
+    EXPECTED_STYLE = "ui info message top attached m-0 inv-banner"
     banner = _create_banner(EXPECTED_MSG, EXPECTED_CATEGORY)
     style = style_category(banner.category)
-
     html = template.render()
     assert EXPECTED_MSG in html
-    assert style.endswith(EXPECTED_STYLE)
-    assert style in html
+    assert style.endswith(EXPECTED_CATEGORY)
+    assert EXPECTED_STYLE in html
 
     # change message and category
     EXPECTED_MSG = "Test banner warning message"
     EXPECTED_CATEGORY = "warning"
-    EXPECTED_STYLE = "ui warning flashed top attached manage m-0 message"
+    EXPECTED_STYLE = "ui warning message top attached m-0 inv-banner"
 
     banner.message = EXPECTED_MSG
     banner.category = EXPECTED_CATEGORY
@@ -73,5 +72,5 @@ def test_jinja_macro(app, db):
 
     html = template.render()
     assert EXPECTED_MSG in html
-    assert style.endswith(EXPECTED_STYLE)
-    assert style in html
+    assert style.endswith(EXPECTED_CATEGORY)
+    assert EXPECTED_STYLE in html

invenio-banners-3.2.0/.github/workflows/pypi-publish.yml

@@ -1,28 +0,0 @@
-on:
-  push:
-    tags:
-      - v*
-
-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
-      - name: Build package
-        run: |
-          python setup.py sdist bdist_wheel
-      - name: pypi-publish
-        uses: pypa/gh-action-pypi-publish@v1.3.1
-        with:
-          user: __token__
-
-          password: ${{ secrets.pypi_token }}
-

invenio-banners-3.2.0/PKG-INFO

@@ -1,100 +0,0 @@
-Metadata-Version: 2.1
-Name: invenio-banners
-Version: 3.2.0
-Summary: Invenio-Banners is a module used to create and show banners with useful messages to users.
-Home-page: https://github.com/inveniosoftware/invenio-banners
-Author: CERN
-Author-email: info@inveniosoftware.org
-License: MIT
-Description: ..
-            Copyright (C) 2020 CERN.
-        
-            Invenio-Banners is free software; you can redistribute it and/or modify
-            it under the terms of the MIT License; see LICENSE file for more details.
-        
-        =================
-         Invenio-Banners
-        =================
-        
-        .. image:: https://img.shields.io/travis/inveniosoftware/invenio-banners.svg
-                :target: https://travis-ci.org/inveniosoftware/invenio-banners
-        
-        .. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-banners.svg
-                :target: https://coveralls.io/r/inveniosoftware/invenio-banners
-        
-        .. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-banners.svg
-                :target: https://github.com/inveniosoftware/invenio-banners/releases
-        
-        .. image:: https://img.shields.io/pypi/dm/invenio-banners.svg
-                :target: https://pypi.python.org/pypi/invenio-banners
-        
-        .. image:: https://img.shields.io/github/license/inveniosoftware/invenio-banners.svg
-                :target: https://github.com/inveniosoftware/invenio-banners/blob/master/LICENSE
-        
-        Create and show banners with useful messages to users.
-        
-        Further documentation is available on
-        https://invenio-banners.readthedocs.io/
-        
-        ..
-            Copyright (C) 2020-2024 CERN.
-        
-            Invenio-Banners is free software; you can redistribute it and/or modify
-            it under the terms of the MIT License; see LICENSE file for more details.
-        
-        Changes
-        =======
-        
-        Version v3.2.0 (released 2024-11-05)
-        
-        - feat(administration): use html editor for message
-        - global: change the code to be compatible with sqlalchemy >= 2.0
-        - global: add compatibility layer to move to flask >= 3.0
-        
-        Version v3.1.0 (released 2024-08-07)
-        
-        - http headers: use and adjust vnd.inveniordm.v1+json http accept header
-        
-        Version 3.0.2 (released 2024-07-17)
-        
-        - errors: implement REST validation error for banner loader
-        
-        Version 3.0.1 (released 2024-02-21)
-        
-        - Moved admin menu item for banners to site administration category
-        
-        Version 3.0.0 (released 2024-01-31)
-        
-        - installation: bump invenio-administration
-        
-        Version 2.1.1 (released 2023-07-24)
-        
-        - ui: remove bottom margin
-        
-        Version 2.1.0 (released 2023-03-02)
-        
-        - remove deprecated flask-babelex imports
-        - install invenio-i18n explicitly
-        
-        Version 2.0.0 (released 2023-02-15)
-        
-        - global: refactor into resource/service pattern
-        - global: implement CRUD operations
-        - global: implement best practices for packaging (declarative cfg), code
-          linting (black) and testing
-        - search: improve banners search by query params
-        - administration: integrate banners view module
-        
-        
-        Version 1.0.0a1 (release 2020-10-25)
-        ------------------------------------
-        
-        - Initial public release.
-        
-Keywords: Invenio Banners
-Platform: any
-Classifier: Development Status :: 1 - Planning
-Requires-Python: >=3.7
-Provides-Extra: tests
-Provides-Extra: opensearch1
-Provides-Extra: opensearch2

invenio-banners-3.2.0/invenio_banners.egg-info/PKG-INFO

@@ -1,100 +0,0 @@
-Metadata-Version: 2.1
-Name: invenio-banners
-Version: 3.2.0
-Summary: Invenio-Banners is a module used to create and show banners with useful messages to users.
-Home-page: https://github.com/inveniosoftware/invenio-banners
-Author: CERN
-Author-email: info@inveniosoftware.org
-License: MIT
-Description: ..
-            Copyright (C) 2020 CERN.
-        
-            Invenio-Banners is free software; you can redistribute it and/or modify
-            it under the terms of the MIT License; see LICENSE file for more details.
-        
-        =================
-         Invenio-Banners
-        =================
-        
-        .. image:: https://img.shields.io/travis/inveniosoftware/invenio-banners.svg
-                :target: https://travis-ci.org/inveniosoftware/invenio-banners
-        
-        .. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-banners.svg
-                :target: https://coveralls.io/r/inveniosoftware/invenio-banners
-        
-        .. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-banners.svg
-                :target: https://github.com/inveniosoftware/invenio-banners/releases
-        
-        .. image:: https://img.shields.io/pypi/dm/invenio-banners.svg
-                :target: https://pypi.python.org/pypi/invenio-banners
-        
-        .. image:: https://img.shields.io/github/license/inveniosoftware/invenio-banners.svg
-                :target: https://github.com/inveniosoftware/invenio-banners/blob/master/LICENSE
-        
-        Create and show banners with useful messages to users.
-        
-        Further documentation is available on
-        https://invenio-banners.readthedocs.io/
-        
-        ..
-            Copyright (C) 2020-2024 CERN.
-        
-            Invenio-Banners is free software; you can redistribute it and/or modify
-            it under the terms of the MIT License; see LICENSE file for more details.
-        
-        Changes
-        =======
-        
-        Version v3.2.0 (released 2024-11-05)
-        
-        - feat(administration): use html editor for message
-        - global: change the code to be compatible with sqlalchemy >= 2.0
-        - global: add compatibility layer to move to flask >= 3.0
-        
-        Version v3.1.0 (released 2024-08-07)
-        
-        - http headers: use and adjust vnd.inveniordm.v1+json http accept header
-        
-        Version 3.0.2 (released 2024-07-17)
-        
-        - errors: implement REST validation error for banner loader
-        
-        Version 3.0.1 (released 2024-02-21)
-        
-        - Moved admin menu item for banners to site administration category
-        
-        Version 3.0.0 (released 2024-01-31)
-        
-        - installation: bump invenio-administration
-        
-        Version 2.1.1 (released 2023-07-24)
-        
-        - ui: remove bottom margin
-        
-        Version 2.1.0 (released 2023-03-02)
-        
-        - remove deprecated flask-babelex imports
-        - install invenio-i18n explicitly
-        
-        Version 2.0.0 (released 2023-02-15)
-        
-        - global: refactor into resource/service pattern
-        - global: implement CRUD operations
-        - global: implement best practices for packaging (declarative cfg), code
-          linting (black) and testing
-        - search: improve banners search by query params
-        - administration: integrate banners view module
-        
-        
-        Version 1.0.0a1 (release 2020-10-25)
-        ------------------------------------
-        
-        - Initial public release.
-        
-Keywords: Invenio Banners
-Platform: any
-Classifier: Development Status :: 1 - Planning
-Requires-Python: >=3.7
-Provides-Extra: tests
-Provides-Extra: opensearch1
-Provides-Extra: opensearch2