Merge pull request #548 from digitalfabrik/develop

Release `2024.11.0`

.circleci/config.yml

@@ -5,7 +5,7 @@ orbs:
 jobs:
   install:
     docker:
-      - image: cimg/python:3.9
+      - image: cimg/python:3.11
     steps:
       - checkout
       - restore_cache:
@@ -33,7 +33,7 @@ jobs:
             - lunes_cms.egg-info
   compile-translations:
     docker:
-      - image: cimg/python:3.9
+      - image: cimg/python:3.11
     steps:
       - checkout
       - attach_workspace:
@@ -56,7 +56,7 @@ jobs:
             - lunes_cms/locale/de/LC_MESSAGES/djangojs.mo
   pylint:
     docker:
-      - image: "cimg/python:3.9"
+      - image: "cimg/python:3.11"
     steps:
       - checkout
       - attach_workspace:
@@ -84,7 +84,7 @@ jobs:
             - cc-test-reporter
   test:
     docker:
-      - image: cimg/python:3.9
+      - image: cimg/python:3.11
         environment:
           LUNES_CMS_SECRET_KEY: circleci-dummy-key
       - image: cimg/postgres:14.1
@@ -137,7 +137,7 @@ jobs:
             ./cc-test-reporter sum-coverage -o - coverage/codeclimate.*.json | ./cc-test-reporter upload-coverage --debug --input -
   black:
     docker:
-      - image: cimg/python:3.9
+      - image: cimg/python:3.11
     steps:
       - checkout
       - attach_workspace:
@@ -149,7 +149,7 @@ jobs:
             black --check .
   check-translations:
     docker:
-      - image: cimg/python:3.9
+      - image: cimg/python:3.11
     steps:
       - checkout
       - attach_workspace:
@@ -162,7 +162,7 @@ jobs:
           command: ./tools/check_translations.sh
   build-documentation:
     docker:
-      - image: cimg/python:3.9
+      - image: cimg/python:3.11
     steps:
       - checkout
       - attach_workspace:
@@ -172,7 +172,7 @@ jobs:
           command: ./tools/build_documentation.sh
   bump-dev-version:
     docker:
-      - image: cimg/python:3.9
+      - image: cimg/python:3.11
     steps:
       - checkout
       - attach_workspace:
@@ -217,7 +217,7 @@ jobs:
             - lunes_cms/__init__.py
   bump-version:
     docker:
-      - image: cimg/python:3.9
+      - image: cimg/python:3.11
     steps:
       - checkout
       - attach_workspace:
@@ -267,7 +267,7 @@ jobs:
           command: git checkout develop && git merge main --commit --no-edit && git push
   build-package:
     docker:
-      - image: cimg/python:3.9
+      - image: cimg/python:3.11
     steps:
       - checkout
       - attach_workspace:
@@ -284,7 +284,7 @@ jobs:
             - dist
   publish-package:
     docker:
-      - image: cimg/python:3.9
+      - image: cimg/python:3.11
     steps:
       - checkout
       - attach_workspace:
@@ -293,10 +293,10 @@ jobs:
           name: Publish lunes-cms package to (Test-)PyPI
           command: |
             source .venv/bin/activate
-            twine upload --non-interactive ./dist/lunes-cms-*.tar.gz
+            twine upload --non-interactive ./dist/lunes_cms-*.tar.gz
   create-release:
     docker:
-      - image: cimg/python:3.9
+      - image: cimg/python:3.11
     steps:
       - checkout
       - attach_workspace:

.circleci/scripts/create_release.py

@@ -34,9 +34,9 @@ def main():
     logo_url = "https://raw.githubusercontent.com/digitalfabrik/lunes-cms/c242f6b723da80e5d9f9ed7ca9c6f961bb095386/.github/logo.png"
     compare_url = "https://github.com/digitalfabrik/lunes-cms/compare"
     body = (
-        f"### ![]({logo_url}) lunes-cms `{args.tag}`"
-        f"\n\n### Changelog\n\n{args.changelog}\n\n"
-        f"Compare changes: [{args.prev_tag} → {args.tag}]({compare_url}/{args.prev_tag}...{args.tag})"
+        f"### ![]({logo_url}) lunes-cms `{args.tag}`\n\n###"
+        f" Changelog\n\n{args.changelog}\n\nCompare changes: [{args.prev_tag} →"
+        f" {args.tag}]({compare_url}/{args.prev_tag}...{args.tag})"
     )
 
     # Create release

.circleci/scripts/get_access_token.py

@@ -22,7 +22,8 @@ def main():
         deliverino_private_key = os.environ["DELIVERINO_PRIVATE_KEY"]
     except KeyError as e:
         raise RuntimeError(
-            "Please make sure this step has access to the 'deliverino' CircleCI context."
+            "Please make sure this step has access to the 'deliverino' CircleCI"
+            " context."
         ) from e
 
     # Generate payload for the JWT

.readthedocs.yaml

@@ -7,7 +7,7 @@ version: 2
 build:
   os: ubuntu-20.04
   tools:
-    python: "3.9"
+    python: "3.11"
   jobs:
     pre_build:
       - ./tools/build_documentation.sh

CHANGELOG.md

@@ -1,6 +1,10 @@
 UNRELEASED
 ----------
 
+* [ [#512](https://github.com/digitalfabrik/lunes-cms/issues/512) ] Gender neutral language
+* [ [#532](https://github.com/digitalfabrik/lunes-cms/issues/532) ] Fix color of feedback list in dark mode
+* [ [#544](https://github.com/digitalfabrik/lunes-cms/issues/544) ] Refactoring of toggle_plural_field.js
+
 
 2024.6.0
 --------

README.md

@@ -19,12 +19,12 @@ For more information please see our [GoVolunteer ad](https://translate.google.co
 
 Following packages are required before installing the project (install them with your package manager):
 
-* python3.8 or higher
-* python3-pip
-* python3-venv
-* libpq-dev to compile psycopg2
-* gettext and pcregrep to use the translation features
-* ffmpeg for audio processing
+* `python3.11` or higher
+* `python3-pip`
+* `python3-venv`
+* `libpq-dev` to compile psycopg2
+* `gettext` and `pcregrep` to use the translation features
+* `ffmpeg` for audio processing
 
 E.g. on Debian-based distributions, use:
 

docs/src/conf.py

@@ -38,7 +38,7 @@
 #: The project author
 author = "Lunes"
 #: The full version, including alpha/beta/rc tags
-release = "2024.6.0"
+release = "2024.11.0"
 #: GitHub username
 github_username = "digitalfabrik"
 #: GitHub repository name

docs/src/installation.rst

@@ -13,7 +13,7 @@ Prerequisites
 Followings are required before installing the project (install them with your manager):
 
 * `git <https://git-scm.com/>`_
-* `python3.8 <https://www.python.org/downloads/release/python-380/>`_ or higher
+* `python3.11 <https://www.python.org/downloads/release/python-3110/>`_ or higher
 * `python3-pip <https://packages.ubuntu.com/search?keywords=python3-pip>`_ (`Debian-based distributions <https://en.wikipedia.org/wiki/Category:Debian-based_distributions>`_, e.g. `Ubuntu <https://ubuntu.com>`__) / `python-pip <https://www.archlinux.de/packages/extra/x86_64/python-pip>`_ (`Arch-based distributions <https://wiki.archlinux.org/index.php/Arch-based_distributions>`_)
 * `python3-venv <https://docs.python.org/3/library/venv.html>`__
 * `libpq-dev <https://www.postgresql.org/docs/9.5/libpq.html>`__ to compile `psycopg2 <https://www.psycopg.org/docs/install.html#build-prerequisites>`__

lunes_cms/README.md

@@ -19,7 +19,7 @@ This is the content management system for the vocabulary trainer app Lunes, whic
 
 Following packages are required before installing the project (install them with your package manager):
 
-* python3.8 or greater
+* python3.11 or greater
 * python3-pip
 * python3-venv
 * ffmpeg

lunes_cms/api/exception_handler.py

@@ -0,0 +1,16 @@
+from rest_framework.views import exception_handler
+from rest_framework import status
+
+
+def custom_exception_handler(exc, context):
+    """
+    Extend the default exception_handler of rest_framework.
+    Purpose: Simplify testing by ensuring that the detail message is the same for all 404 responses.
+    """
+
+    response = exception_handler(exc, context)
+
+    if response.status_code == status.HTTP_404_NOT_FOUND:
+        response.data["detail"] = "Not found."
+
+    return response

lunes_cms/api/utils.py

@@ -5,7 +5,7 @@
 from django.core.exceptions import PermissionDenied
 from django.db.models import Count, Q
 from django.http import JsonResponse
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 
 from rest_framework import routers
 
@@ -181,9 +181,11 @@ def find_duplicates_for_word(request, word):
         result = {
             "message": _("This word is already registered in the system."),
             "word": document_to_string(duplicate) + " (" + duplicate.word_type + ")",
-            "definition": _("Definition: ") + duplicate.definition
-            if duplicate.definition
-            else _("Definition: ") + _("No definition is provided for this word."),
+            "definition": (
+                _("Definition: ") + duplicate.definition
+                if duplicate.definition
+                else _("Definition: ") + _("No definition is provided for this word.")
+            ),
             "training_sets": _("Training sets: ") + training_sets_description,
         }
 

lunes_cms/api/v1/serializers/feedback_serializer.py

@@ -1,6 +1,6 @@
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ObjectDoesNotExist
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 from rest_framework import serializers
 
 from ....cms.models import Feedback
@@ -19,7 +19,8 @@ class FeedbackSerializer(serializers.ModelSerializer):
         ),
         error_messages={
             "does_not_exist": _(
-                "The content type must be either 'discipline', 'training set' or 'document'."
+                "The content type must be either 'discipline', 'training set' or"
+                " 'document'."
             ),
         },
     )

lunes_cms/api/v1/urls.py

@@ -14,7 +14,7 @@
 router = OptionalSlashRouter()
 router.register(r"disciplines", views.DisciplineViewSet, "disciplines")
 router.register(
-    "disciplines_by_level/",
+    "disciplines_by_level",
     views.DisciplineFilteredViewSet,
     "disciplines_overview",
 )
@@ -41,7 +41,9 @@
 )
 
 router.register(
-    r"document_by_id/(?P<document_id>[0-9]+)", views.DocumentByIdViewSet, "documents"
+    r"document_by_id/(?P<document_id>[0-9]+)",
+    views.DocumentByIdViewSet,
+    "document_by_id",
 )
 router.register(r"words", views.WordViewSet, "words")
 router.register(r"group_info", views.GroupViewSet, "group_by_id")

lunes_cms/cms/admin.py

@@ -5,7 +5,7 @@
 from __future__ import absolute_import, unicode_literals
 
 from django.contrib import admin
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 
 from .admins import (
     DisciplineAdmin,

lunes_cms/cms/admins/discipline_admin.py

@@ -10,7 +10,7 @@
 from django.http import HttpResponse
 from django.urls import reverse
 from django.utils.safestring import mark_safe
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 from mptt.admin import DraggableMPTTAdmin
 from tablib import Dataset
 

lunes_cms/cms/admins/document_admin.py

@@ -2,7 +2,7 @@
 
 from django.contrib import admin
 from django.db.models import Case, Exists, IntegerField, OuterRef, Value, When
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 
 from ..list_filter import (
     ApprovedImageListFilter,
@@ -258,5 +258,5 @@ class Media:
         css = {"all": ("css/document_form.css",)}
         js = (
             "js/image_preview.js",
-            "js/toggle_plural_field.js",
+            "js/toggle_document_form_fields.js",
         )

lunes_cms/cms/admins/document_resource.py

@@ -1,4 +1,4 @@
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 from import_export import fields, resources
 from import_export.admin import ExportActionMixin
 
@@ -103,4 +103,13 @@ class Meta:
         """
 
         model = Document
-        fields = ()
+        fields = (
+            "word",
+            "word_type",
+            "singular_article",
+            "plural_article",
+            "has_audio",
+            "example_sentence",
+            "creation_date",
+            "training_sets",
+        )

lunes_cms/cms/admins/sponsor_admin.py

@@ -1,5 +1,5 @@
 from django.contrib import admin
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 
 from ..utils import get_image_tag
 

lunes_cms/cms/admins/training_set_admin.py

@@ -6,7 +6,7 @@
 from django.urls import reverse
 from django.utils.safestring import mark_safe
 from django.utils.translation import ngettext
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 from mptt.admin import DraggableMPTTAdmin
 
 from ..forms import TrainingSetForm
@@ -217,8 +217,10 @@ def make_released(self, request, queryset):
             messages.error(
                 request,
                 ngettext(
-                    "The training set {} could not be released because it contains less than {} vocabulary words with confirmed images.",
-                    "The training sets {} could not be released because they contain less than {} vocabulary words with confirmed images.",
+                    "The training set {} could not be released because it contains less"
+                    " than {} vocabulary words with confirmed images.",
+                    "The training sets {} could not be released because they contain"
+                    " less than {} vocabulary words with confirmed images.",
                     len(invalid_trainingsets),
                 ).format(
                     iter_to_string(invalid_trainingsets),

lunes_cms/cms/apps.py

@@ -1,5 +1,5 @@
 from django.apps import AppConfig
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 
 
 class CmsConfig(AppConfig):