i18n engine for Django Framework
Installation
Use the package manager pip to install django-i18n
pip3 install django-i18nSetup
Before using library, you need setup some things in your django project, please follow this steps
- Setup all required variables in your settings.py
LOCALE = 'es' # Mandatory
LOCALE_FALLBACK = 'en' # Optional, default = 'en'
LOCALES = ['es'] # Mandatory
LOCALES_PATH = os.path.join(BASE_DIR, 'locales') # Optional, default path './locales' folder
INSTALLED_APPS = [
...
'django_i18n',
...
]- After that, you need create a locales folder (Setted in LOCALES_PATH variable in your settings.py), inside your folder you need some yml files with EXACT names as you setted in LOCALES variable, next you can see an example
en:
my:
title: "An incredible title"
content: "Hello %{name}"Usage in python files
from django_i18n.tools import translate, set_locale, handle_orm_errors
translate("my.title")
# OR
translate('my.content', name='World')
# Set locale
set_locale(locale="en", fallback="es") # Fallback is optional, default value is 'en'
# Handle ORM errors
form = MyForm(data)
handle_orm_errors(list_errors=form.errors, as_json=False)
# List errors is a Django forms errors
#as_json return dict as json stringUsage in template
{% load t from django_i18n %}
<html>
<head>
<title>{% t 'my.title' %}</title>
</head>
<body>
<h1>{% t 'my.content' name='World' %}</h1>
</body>
</head>Fallback response
If you have setted a fallback, each translation may be return
translate('my.locale')
#> Fallback: An incredible titleIf that key doesn't exists in your locale and your fallback, this is the response
translate('my.locale2')
#> Translation missin my.locale2To Do
- Forms complete support handler
- Default messages for Django forms
- Other supported formats
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
