oarepo-multilingual 2.0.1a1

Multilingual support for OARepo

OARepo multilingual data model

Multilingual string data model for OARepo.

Instalation

    pip install oarepo-multilingual

Usage

The library provides multilingual type for json schema with marshmallow validation and deserialization and elastic search mapping. Multilingual is type which allows you to add multilingual strings in your json schema in format "en":"something, "en-us":"something else".

JSON Schema

Add this package to your dependencies and use it via $ref in json schema as "[server]/schemas/multilingual-v2.0.0.json#/definitions/multilingual".

Usage example

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
            "$ref": "https://localhost:5000/schemas/multilingual-v2.0.0.json#/definitions/multilingual"
      }
  }
}

{
  "type": "object",
  "properties": {
    "title": {
            "en": "something",
            "en-us": "something else"
      }
  }
}

Marshmallow

For data validation and deserialization.

If marshmallow validation is performed within application context, languages are validated against SUPPORTED_LANGUAGES config. If the validation is performed outside app context, the keys are not checked against a list of languages but a generic validation is performed - keys must be in ISO 639-1 or language-region format from RFC 5646.

Usage example

    class MD(marshmallow.Schema):
         title = MultilingualStringSchemaV2()

    data = {
        'title':
            {
            "en": "something",
            "en-us": "something else",
            }
        }

    MD().load(data)

Supported languages validation

You can specified supported languages in your application configuration in SUPPORTED_LANGUAGES . Then only these languages are allowed as multilingual string. You must specified your languages in format "en" or "en-us".

Usage example

app.config.update(SUPPORTED_LANGUAGES = ["cs", "en"])

Elastic search mapping

Defince type of your multilingual string as multilingual

Usage example

{
  "mappings": {
    "properties": {
    "title":
      {"type": "multilingual"}
    }
  }
}

Changes

Version 2.0.0 (released 2020-08-21)

• Initial public release.