Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Multilingual support for django-rest-framework

Project description

django-parler-rest
==================

.. image:: https://travis-ci.org/django-parler/django-parler-rest.svg?branch=master
:target: http://travis-ci.org/django-parler/django-parler-rest
.. image:: https://img.shields.io/pypi/v/django-parler-rest.svg
:target: https://pypi.python.org/pypi/django-parler-rest/
.. image:: https://img.shields.io/pypi/l/django-parler-rest.svg
:target: https://pypi.python.org/pypi/django-parler-rest/
.. image:: https://img.shields.io/codecov/c/github/django-parler/django-parler-rest/master.svg
:target: https://codecov.io/github/django-parler/django-parler-rest?branch=master

Adding translation support to django-rest-framework_.

This package adds support for TranslatableModels from django-parler_ to django-rest-framework_.


Installation
============

::

pip install django-parler-rest

Usage
=====

* 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 <https://django-parler.readthedocs.io/en/latest/>`_:

.. code-block:: python

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):
return self.name


The model translations can be exposed as a separate serializer:

.. code-block:: python

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')


.. note:: The ``TranslatedFieldsField`` can only be used in a serializer that inherits from ``TranslatableModelSerializer``.


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

.. code-block:: application/json

{
"id": 528,
"country_code": "NL",
"translations": {
"nl": {
"name": "Nederland",
"url": "http://nl.wikipedia.org/wiki/Nederland"
},
"en": {
"name": "Netherlands",
"url": "http://en.wikipedia.org/wiki/Netherlands"
},
"de" {
"name": "Niederlande",
"url": "http://de.wikipedia.org/wiki/Niederlande"
}
}
}


Contributing
============

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 setup.py test # install dependencies and run tests with coverage


.. _django-parler: https://github.com/django-parler/django-parler
.. _django-rest-framework: http://www.django-rest-framework.org/


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_parler_rest-2.0-py2.py3-none-any.whl (7.0 kB) Copy SHA256 hash SHA256 Wheel py2.py3
django-parler-rest-2.0.tar.gz (10.8 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page