PB-2241: implement new version of BABS signatures

.pylintrc

@@ -36,10 +36,6 @@ load-plugins=pylint_flask
 # Pickle collected data for later comparisons.
 persistent=yes
 
-# When enabled, pylint would attempt to guess common misconfiguration and emit
-# user-friendly hints instead of false-positive error messages.
-suggestion-mode=yes
-
 # Allow loading of arbitrary C extensions. Extensions are imported into the
 # active Python interpreter and may run arbitrary code.
 unsafe-load-any-extension=no
@@ -480,6 +476,9 @@ preferred-modules=
 
 [DESIGN]
 
+# Maximum number of positional arguments for function / method.
+max-positional-arguments = 8
+
 # Maximum number of arguments for function / method.
 max-args=5
 
@@ -513,8 +512,5 @@ min-public-methods=2
 
 [EXCEPTIONS]
 
-# Exceptions that will emit a warning when being caught. Defaults to
-# "BaseException, Exception".
-overgeneral-exceptions=BaseException,
-                       Exception,
-                       StandardError
+# Exceptions that will emit a warning when being caught.
+overgeneral-exceptions=builtins.BaseException,builtins.Exception

Pipfile

@@ -16,9 +16,11 @@ werkzeug = "~=3.0.4"
 [dev-packages]
 yapf = "*"
 nose2 = "*"
-pylint = "*"
 pylint-flask = "*"
 cairosvg = "*"
+pandas = "*"
+openpyxl = "*"
+pylint = "*"
 
 [requires]
 python_version = "3.12"

README.md

@@ -20,6 +20,7 @@
 - [Docker](#docker)
 - [Maintenance](#maintenance)
   - [Convert Symbols from svg to png](#convert-symbols-from-svg-to-png)
+  - [Additional requirements for new symbol sets](#additional-requirements-for-new-symbol-sets)
 - [Deployment](#deployment)
   - [Deployment configuration](#deployment-configuration)
 
@@ -175,6 +176,11 @@ pipenv run python scripts/svg2png.py --help
 ```pipenv run python scripts/svg2png.py -I ./tmp/new-icons -O ./static/images/babs2 -W 48 -H 48
 ```
 
+### Additional requirements for new symbol sets
+
+- No special characters, umlauts or spaces in the filenames, such as e.g. `, `, `'` and the like. Only allowed exception is `-`. So all special characters will be replaced by `-` and umlauts will be mapped, e.g. `ö` to `oe`, `Ö` to `OE` and so on.
+- The symbol set provider should provide us with a list (e.g. Excel) that includes a column with the filename (including the `.svg` extension) of each icon and another column with the text, that we show in the mouseover tooltip when hovering over that specific icon. We need those columns for all the supported languages.
+
 ## Deployment
 
 ### Deployment configuration

app/settings.py

@@ -20,7 +20,14 @@
 
 UNLISTED_ICON_SETS = split_and_clean_string(os.environ.get('UNLISTED_ICON_SETS', ''))
 
-ICON_SET_LANGUAGE = {'babs-v2-de': 'de', 'babs-v2-fr': 'fr', 'babs-v2-it': 'it'}
+ICON_SET_LANGUAGE = {
+    'babs-v2-de': 'de',
+    'babs-v2-fr': 'fr',
+    'babs-v2-it': 'it',
+    'babs-v3-de': 'de',
+    'babs-v3-fr': 'fr',
+    'babs-v3-it': 'it'
+}
 DEFAULT_COLOR = {"r": '255', "g": '0', "b": '0'}
 DEFAULT_ICON_SIZE = 48
 TRAP_HTTP_EXCEPTIONS = True