feat: add i18n support

app/babel_mapping.ini

@@ -0,0 +1,3 @@
+[python: **.py]
+[jinja2: **/templates/**.html]
+extensions=jinja2.ext.i18n,jinja2.ext.autoescape,jinja2.ext.with_

app/config.py.example

@@ -12,6 +12,9 @@ MEDIA_DIRECTORY = 'media'
 PICTURE_EXTENSION = '.png'
 AVATAR_SIZE = (120, 120)
 
+# DEFAULT WEBSITE LANGUAGE
+WEBSITE_LANGUAGE = "en"
+
 email_conf = ConnectionConfig(
     MAIL_USERNAME=os.getenv("MAIL_USERNAME") or "user",
     MAIL_PASSWORD=os.getenv("MAIL_PASSWORD") or "password",

app/database/models.py

@@ -14,8 +14,8 @@ class User(Base):
     full_name = Column(String)
     description = Column(String, default="Happy new user!")
     avatar = Column(String, default="profile.png")
-
     is_active = Column(Boolean, default=True)
+    language_id = Column(Integer, ForeignKey("languages.id"))
 
     events = relationship(
         "Event", cascade="all, delete", back_populates="owner")
@@ -32,3 +32,10 @@ class Event(Base):
     owner_id = Column(Integer, ForeignKey("users.id"))
 
     owner = relationship("User", back_populates="events")
+
+
+class Language(Base):
+    __tablename__ = "languages"
+
+    id = Column(Integer, primary_key=True, index=True)
+    name = Column(String, unique=True, nullable=False)

app/dependencies.py

@@ -4,10 +4,10 @@
 
 from app import config
 
-
 APP_PATH = os.path.dirname(os.path.realpath(__file__))
 MEDIA_PATH = os.path.join(APP_PATH, config.MEDIA_DIRECTORY)
 STATIC_PATH = os.path.join(APP_PATH, "static")
 TEMPLATES_PATH = os.path.join(APP_PATH, "templates")
 
 templates = Jinja2Templates(directory=TEMPLATES_PATH)
+templates.env.add_extension('jinja2.ext.i18n')

app/internal/languages.py

@@ -0,0 +1,89 @@
+import gettext
+import os
+from pathlib import Path
+from typing import Any, Generator
+
+from app import config
+from app.dependencies import templates
+
+LANGUAGE_DIR = "app/locales"
+LANGUAGE_DIR_TEST = "../app/locales"
+TRANSLATION_FILE = "base"
+
+
+def set_ui_language(language: str = None) -> None:
+    """Set the gettext translations to a given language.
+    If the language requested is not supported, the translations default
+    to the value of config.WEBSITE_LANGUAGE.
+
+    Args:
+        language (str, optional): a valid language code that follows RFC 1766.
+            Defaults to None.
+            See also the Language Code Identifier (LCID) Reference for a list of
+            valid language codes.
+
+    .. _RFC 1766:
+        https://tools.ietf.org/html/rfc1766.html
+
+    .. _Language Code Identifier (LCID) Reference:
+        https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c # noqa: E501
+    """
+
+    # TODO: Connect when user registration is completed.
+    # if not language:
+    #     language = _get_display_language(user_id: int)
+
+    language_dir = _get_language_directory()
+
+    if language not in _get_supported_languages(language_dir):
+        language = config.WEBSITE_LANGUAGE
+
+    translations = gettext.translation(TRANSLATION_FILE,
+                                       localedir=language_dir,
+                                       languages=[language])
+    translations.install()
+    templates.env.install_gettext_translations(translations, newstyle=True)
+
+
+# TODO: Waiting for user registration. Add doc.
+# def _get_display_language(user_id: int) -> str:
+#     # TODO: handle user language setting:
+#     #  If user is logged in, get language setting.
+#     #  If user is not logged in, get default site setting.
+#
+#     if db_user:
+#         return db_user.language
+#     return config.WEBSITE_LANGUAGE
+
+
+def _get_language_directory() -> str:
+    """Get and return the language directory relative path.
+
+    Returns:
+        str: the language directory relative path.
+    """
+    language_dir = LANGUAGE_DIR
+    if Path(LANGUAGE_DIR_TEST).is_dir():
+        # If running from test, change dir path.
+        language_dir = LANGUAGE_DIR_TEST
+    return language_dir
+
+
+def _get_supported_languages(language_dir: str = None) -> \
+        Generator[str, Any, None]:
+    """Get and return a generator of supported translation languages codes.
+
+    Args:
+        language_dir (str, optional): the path of the language directory.
+            Defaults to None.
+
+    Returns:
+        Generator[str, Any, None]: a generator expression of supported
+            translation languages codes.
+    """
+
+    if not language_dir:
+        language_dir = _get_language_directory()
+
+    return (language.name for language in
+            [Path(f.path) for f in os.scandir(language_dir) if f.is_dir()])

app/locales/base.pot

@@ -0,0 +1,124 @@
+# Translations template for PROJECT.
+# Copyright (C) 2021 ORGANIZATION
+# This file is distributed under the same license as the PROJECT project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2021.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PROJECT VERSION\n"
+"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
+"POT-Creation-Date: 2021-01-26 21:30+0200\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.0\n"
+
+#: app/routers/profile.py:19
+msgid "Not found"
+msgstr ""
+
+#: app/templates/agenda.html:11
+msgid "From"
+msgstr ""
+
+#: app/templates/agenda.html:13
+msgid "to"
+msgstr ""
+
+#: app/templates/agenda.html:33
+msgid "Start date is greater than end date"
+msgstr ""
+
+#: app/templates/agenda.html:35
+msgid "No events found..."
+msgstr ""
+
+#: app/templates/base.html:18
+msgid "Calendar"
+msgstr ""
+
+#: app/templates/base.html:26
+msgid "Home"
+msgstr ""
+
+#: app/templates/base.html:29
+msgid "Profile"
+msgstr ""
+
+#: app/templates/base.html:32
+msgid "Sign in"
+msgstr ""
+
+#: app/templates/base.html:35
+msgid "Sign up"
+msgstr ""
+
+#: app/templates/base.html:40
+msgid "Agenda"
+msgstr ""
+
+#: app/templates/profile.html:53
+msgid "Update name"
+msgstr ""
+
+#: app/templates/profile.html:60 app/templates/profile.html:82
+#: app/templates/profile.html:103 app/templates/profile.html:127
+msgid "Save changes"
+msgstr ""
+
+#: app/templates/profile.html:74
+msgid "Update email"
+msgstr ""
+
+#: app/templates/profile.html:95
+msgid "Update description"
+msgstr ""
+
+#: app/templates/profile.html:118
+msgid "Update photo"
+msgstr ""
+
+#: app/templates/profile.html:144
+msgid "Settings"
+msgstr ""
+
+#: app/templates/profile.html:161
+msgid "Features"
+msgstr ""
+
+#: app/templates/profile.html:165
+msgid "Export my calendar"
+msgstr ""
+
+#: app/templates/profile.html:168 app/templates/profile.html:171
+msgid "Your feature"
+msgstr ""
+
+#: app/templates/profile.html:192
+msgid "Upcoming event on (date)"
+msgstr ""
+
+#: app/templates/profile.html:203
+msgid "The Event (event)"
+msgstr ""
+
+#: app/templates/profile.html:206
+msgid "Last updated (time) ago"
+msgstr ""
+
+#: app/templates/profile.html:223
+msgid "Explore MeetUps near you"
+msgstr ""
+
+#: app/templates/profile.html:232 app/templates/profile.html:241
+msgid "Your Card"
+msgstr ""
+
+#: tests/test_language.py:39
+msgid "test python translation"
+msgstr ""
+

app/locales/en/LC_MESSAGES/base.po

@@ -0,0 +1,125 @@
+# English translations for PROJECT.
+# Copyright (C) 2021 ORGANIZATION
+# This file is distributed under the same license as the PROJECT project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2021.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PROJECT VERSION\n"
+"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
+"POT-Creation-Date: 2021-01-26 21:30+0200\n"
+"PO-Revision-Date: 2021-01-26 21:31+0200\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language: en\n"
+"Language-Team: en <LL@li.org>\n"
+"Plural-Forms: nplurals=2; plural=(n != 1)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.0\n"
+
+#: app/routers/profile.py:19
+msgid "Not found"
+msgstr ""
+
+#: app/templates/agenda.html:11
+msgid "From"
+msgstr ""
+
+#: app/templates/agenda.html:13
+msgid "to"
+msgstr ""
+
+#: app/templates/agenda.html:33
+msgid "Start date is greater than end date"
+msgstr ""
+
+#: app/templates/agenda.html:35
+msgid "No events found..."
+msgstr ""
+
+#: app/templates/base.html:18
+msgid "Calendar"
+msgstr ""
+
+#: app/templates/base.html:26
+msgid "Home"
+msgstr ""
+
+#: app/templates/base.html:29
+msgid "Profile"
+msgstr ""
+
+#: app/templates/base.html:32
+msgid "Sign in"
+msgstr ""
+
+#: app/templates/base.html:35
+msgid "Sign up"
+msgstr ""
+
+#: app/templates/base.html:40
+msgid "Agenda"
+msgstr ""
+
+#: app/templates/profile.html:53
+msgid "Update name"
+msgstr ""
+
+#: app/templates/profile.html:60 app/templates/profile.html:82
+#: app/templates/profile.html:103 app/templates/profile.html:127
+msgid "Save changes"
+msgstr ""
+
+#: app/templates/profile.html:74
+msgid "Update email"
+msgstr ""
+
+#: app/templates/profile.html:95
+msgid "Update description"
+msgstr ""
+
+#: app/templates/profile.html:118
+msgid "Update photo"
+msgstr ""
+
+#: app/templates/profile.html:144
+msgid "Settings"
+msgstr ""
+
+#: app/templates/profile.html:161
+msgid "Features"
+msgstr ""
+
+#: app/templates/profile.html:165
+msgid "Export my calendar"
+msgstr ""
+
+#: app/templates/profile.html:168 app/templates/profile.html:171
+msgid "Your feature"
+msgstr ""
+
+#: app/templates/profile.html:192
+msgid "Upcoming event on (date)"
+msgstr ""
+
+#: app/templates/profile.html:203
+msgid "The Event (event)"
+msgstr ""
+
+#: app/templates/profile.html:206
+msgid "Last updated (time) ago"
+msgstr ""
+
+#: app/templates/profile.html:223
+msgid "Explore MeetUps near you"
+msgstr ""
+
+#: app/templates/profile.html:232 app/templates/profile.html:241
+msgid "Your Card"
+msgstr ""
+
+#: tests/test_language.py:39
+msgid "test python translation"
+msgstr ""
+