Skip to main content

django-klingon is an attempt to make django model translations suck but with no integrations pain in your app!

Project description


Welcome to the documentation for django-klingon!

django-klingon is an attempt to make django model translations suck
but with no integrations pain in your app!

Setup & Integration

In your settings files:
add django-klingon to INSTALLED_APPS:


specify a default language if you want to use your fields to store the
default language:


Extend you models to add API support:
first add Translatable to your model Class definition. This will add the
API functions

from klingon.models import Translatable
class Book(models.Model, Translatable):

in the same model add an attribute to indicate which fields will be

translatable_fields = ('title', 'description')

your model should look like this:

class Book(models.Model, Translatable):
title = models.CharField(max_length=100)
description = models.TextField()
publication_date = models.DateField()

translatable_fields = ('title', 'description')

Add admin capabilities:
you can include an inline to your model admin and a custom action
to create the translations. To do this in your ModelAdmin class do

from klingon.admin import TranslationInline, create_translations
class BookAdmin(admin.ModelAdmin):
inlines = [TranslationInline]
actions = [create_translations]

* see full example in example_project folder of source code of klingon

Using the API

To create the translation you can do the follwing:

Suppose that you have and object called book:

> book = Book.objects.create(
title="The Raven",
description="The Raven is a narrative poem",, 1, 1)

you can create translation for that instances like this

> book.set_translation('es', 'title', 'El Cuervo')
> book.set_translation('es', 'description', 'El Cuervo es un poema narrativo')

a translation could be access individually:

>'es', 'title')
'El Cuervo'
> book.get_translation('es', 'description')
'El Cuervo es un poema narrativo'

or you can get all translations together:

'title': self.es_title,
'description': self.es_description,


pip install django-klingon

Running the Tests

You can run the tests with via::

python test



Project details

Download files

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

Files for django-klingon, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size django-klingon-0.0.1.tar.gz (9.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page