skip to navigation
skip to content

django-parler-rest 1.4.2

Multilingual support for django-rest-framework


Adding translation support to django-rest-framework.

This package adds support for TranslatableModels from django-parler to django-rest-framework.


pip install django-parler-rest


  • First make sure you have django-parler installed and configured.
  • Use the serializers as demonstrated below to expose the translations.

First configure a model, following the django-parler documentation:

from django.db import models
from parler.models import TranslatableModel, TranslatedFields

class Country(TranslatableModel):
    Country database model.

    country_code = models.CharField(_("Country code"), unique=True, db_index=True)

    translations = TranslatedFields(
        name = models.CharField(_("Name"), max_length=200)
        url = models.URLField(_("Webpage"), max_length=200, blank=True)

    class Meta:
        verbose_name = _("Country")
        verbose_name_plural = _("Countries")

    def __unicode__(self):

The model translations can be exposed as a seperate serializer:

from rest_framework import serializers
from parler_rest.serializers import TranslatableModelSerializer, TranslatedFieldsField
from .models import Country   # Example model

class CountrySerializer(TranslatableModelSerializer):
    translations = TranslatedFieldsField(shared_model=Country)

    class Meta:
        model = Country
        fields = ('id', 'country_code', 'translations')

This will expose the fields as a separate dictionary in the JSON output:

    "id": 528,
    "country_code": "NL",
    "translations": {
        "nl": {
            "name": "Nederland",
            "url": ""
        "en": {
            "name": "Netherlands",
            "url": ""
        "de" {
            "name": "Niederlande",
            "url": ""


This module is designed to be generic. In case there is anything you didn’t like about it, or think it’s not flexible enough, please let us know. We’d love to improve it!

If you have any other valuable contribution, suggestion or idea, please let us know as well because we will look into it. Pull requests are welcome too. :-)

Running tests

Tests are run with py.test:

python test  # install dependencies and run tests with coverage
File Type Py Version Uploaded on Size
django-parler-rest-1.4.2.tar.gz (md5) Source 2016-06-17 11KB
django_parler_rest-1.4.2-py2-none-any.whl (md5) Python Wheel py2 2016-06-17 9KB
django_parler_rest-1.4.2-py2.py3-none-any.whl (md5) Python Wheel py2.py3 2016-06-17 9KB