Skip to main content

A Django app that compiles i18n JavaScript catalogs to static files.

Project description

Build Status https://codecov.io/gh/zyegfryed/django-statici18n/branch/main/graph/badge.svg?token=xiaDYAr30F

Overview

When dealing with internationalization in JavaScript code, Django provides the JSONCatalog view which sends out a JavaScript code library with functions that mimic the gettext interface, plus an array of translation strings.

At first glance, it works well and everything is fine. But, because JSONCatalog view is generating JavaScript catalog dynamically on each and every request, it’s adding an overhead that can be an issue with site growth.

That’s what django-statici18n is for:

Collecting JavaScript catalogs from each of your Django apps (and any other place you specify) into a single location that can easily be served in production.

The main website for django-statici18n is github.com/zyegfryed/django-statici18n where you can also file tickets.

Supported Django Versions

django-statici18n works with all the Django versions officially supported by the Django project. At this time of writing, these are the 4.2 (LTS), 5.0 and 5.1 series.

Installation

  1. Use your favorite Python packaging tool to install django-statici18n from PyPI, e.g.:

    pip install django-statici18n
  2. Add 'statici18n' to your INSTALLED_APPS setting:

    INSTALLED_APPS = [
        # ...
        'statici18n',
    ]
  3. Once you have translated and compiled your messages, use the compilejsi18n management command:

    python manage.py compilejsi18n
  4. Add the django.core.context_processors.i18n context processor to the context_processors section for your backend in the TEMPLATES setting - it should have already been set by Django:

    TEMPLATES = [
      {
        # ...
        'OPTIONS': {
          'context_processors': {
            # ...
            'django.template.context_processors.i18n',
          },
        },
      },
    ]
  5. Edit your template(s) and replace the dynamically generated script by the statically generated one:

<script src="{{ STATIC_URL }}jsi18n/{{ LANGUAGE_CODE }}/djangojs.js"></script>

(Optional)

The following step assumes you’re using django.contrib.staticfiles.

  1. Edit your template(s) and use the provided template tag:

{% load statici18n %}
<script src="{% statici18n LANGUAGE_CODE %}"></script>
  1. Or inline the JavaScript directly in your template:

{% load statici18n %}
<script>{% inlinei18n LANGUAGE_CODE %}</script>

Project details


Download files

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

Source Distribution

django_statici18n-2.6.0.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

django_statici18n-2.6.0-py2.py3-none-any.whl (9.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django_statici18n-2.6.0.tar.gz.

File metadata

  • Download URL: django_statici18n-2.6.0.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for django_statici18n-2.6.0.tar.gz
Algorithm Hash digest
SHA256 87ed5adb15d6b32d20f438df76f39f16cc5804f452a8785bebc64729ff08cfb4
MD5 5172ae8a7acd983d9c760087377b27e9
BLAKE2b-256 d4495ee0aa96bf35945f338f625da8f5b659c7e873ff880b831980d3d50619b1

See more details on using hashes here.

File details

Details for the file django_statici18n-2.6.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_statici18n-2.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1bedd5cbffc2cf1772808995fb818756592fc9cd88b79547b6a25a747b23087d
MD5 4afa512790f7d07bf056b98f5d6d9a8d
BLAKE2b-256 c8ed293a0bab322a19c554dff18bb216c003c3f7489794abb4c58ab97f2b71f8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page