django-nece 0.11

Introduction

A “Content Translation Framework” using Postgresql’s jsonb field. It simply sets and gets translations from a jsonb field called translations.

Dependencies

postgresql >= 9.4.5
Django >= 2.2
psycopg2 >= 2.5.4

Installation

via pypi:

pip install django-nece

Usage

Lets say we have a model called Fruit:

from nece.models import TranslationModel

class Fruit(TranslationModel):
    name = CharField(max_length=255)

    def __str__(self):
        return self.name

    class Meta:
        translatable_fields = ('name',)

TranslationModel adds a jsonb field to this table and sets translations in a notation like the one below:

{u'de_de': {u'name': u'Apfel'},
 u'tr_tr': {u'name': u'elma'}}

When we need the German translation we can simply choose the language and get the attribute as usual:

>> f = Fruit.objects.get(name='apple')
>> print(f.name)
apple
>> f.language('de_de')
>> print(f.name)
Apfel

You can also filter out the ones containing any language translation:

>> Fruit.objects.all()
[<Fruit: apple>, <Fruit: pear>, <Fruit: banana>]
>> Fruit.objects.language('tr_tr')
[<Fruit: elma>, <Fruit: armut>]  # there is no translation for banana
>> Fruit.objects.language_or_default('tr_tr')
[<Fruit: elma>, <Fruit: armut>, <Fruit: banana>]
>> Fruit.objects.language('tr_tr').filter(name='elma')
[<Fruit: elma>]
>> Fruit.objects.language('tr_tr').get(name='elma')
<Fruit: elma>

>> fruit._language_code
tr_tr
>> fruit.name
elma
>> fruit.translate(name='armut').save()
>> fruit.name
armut
>> fruit.language('en')
>> fruit.translate('it_it', name='pera')
>> fruit.language('it_it')
>> fruit.name
pera

Settings

TRANSLATIONS_MAP = {
    "en": "en_us",
    "tr": "tr_tr",
    "ar": "ar_sy",
    "bg": "bg_bg",
    "cs": "cs_cz",
    "da": "da_dk",
    ...
}

{'en': 'en_us'}

TRANSLATIONS_FALLBACK = {
    'fr_ca': ['fr_fr'],
    'en_us': ['en_gb'],
}

Admin panel

Use TranslatableModelAdmin for pretty JSON editor (powered by django-admin-json-editor).

Example:

# settings.py
INSTALLED_APPS = [
    ...
    'django_admin_json_editor',
    ...
]

# admin.py
from nece.admin import TranslatableModelAdmin

class PlaceAdmin(TranslatableModelAdmin):
    list_display = ('...')

Contributors & Thanks

• Erkan Ay

• Ayman Khalil

• Gönül Sabah

• Faruk Rahmet

• Mathieu Richardoz

• Marc Hertzog

• Alexey Kotenko

Change Log