Skip to main content

Okrand is an internationalization/translation tool for Django

Project description

Okrand is an internationalization/translation tool for Django.

It is a pure Python program so doesn’t rely on gettext.

Okrand will respect your .gitignore.

Django models

Okrand can upgrade Django models so translation is much easier. You don’t need to write verbose_name anymore! And if you do write them Okrand will upgrade raw strings to gettext_lazy.

Turn this feature on in your setup.cfg:

[tool:okrand]
django_model_upgrade=1
django_model_prefixes=
    your_package.

So concretely this model:

from django.utils.translation import gettext_lazy as _


class Book(Model):
    name = CharField(verbose_name=_('name'))
    isbn = CharField(verbose_name=_('ISBN'))

    class Meta:
        verbose_name = _('book')
        verbose_name = _('books')

Can now be changed to the more natural:

class Book(Model):
    name = CharField()
    isbn = CharField(verbose_name='ISBN')

Note that you don’t need to wrap the verbose_name in a gettext_lazy call anymore.

Installation

First pip install okrand, then add okrand to INSTALLED_APPS.

Add OKRAND_STATIC_PATH to settings, pointing to where Okrand should write the JavaScript catalog files. Typically something like:

OKRAND_STATIC_PATH = Path(BASE_DIR) / 'yourproject' / 'base' / 'static'

If you have a base app to put common stuff.

Configuration

In setup.cfg you set:

  • additional ignore rules beyond .gitignore. These are regexes for the full path.

  • sorting: none (default), alphabetical

  • if the django model upgrade is enabled

  • custom collector functions

[tool:okrand]
ignore=
    .*some_annoying_path.*
sort=alphabetical
django_model_upgrade=1
django_model_prefixes=
    some_app.
    another_app.
find_source_strings_plugins=
    your.module.function_name

Installing the frontend

There is a built in web based frontend to okrand. To install it first install iommi.

Then add the following to your urls.py:

from okrand.views import i18n

urlpatterns = [
    path('i18n/', i18n),
]

What does “Okrand” mean?

Marc Okrand is a linguist who is best known for his work on Star Trek where he created the Klingon language.

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

okrand-1.3.0.tar.gz (30.1 kB view details)

Uploaded Source

Built Distribution

okrand-1.3.0-py2.py3-none-any.whl (29.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file okrand-1.3.0.tar.gz.

File metadata

  • Download URL: okrand-1.3.0.tar.gz
  • Upload date:
  • Size: 30.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for okrand-1.3.0.tar.gz
Algorithm Hash digest
SHA256 d3d99f1503cb30c2ef7b4003e4f0cc76ed94bd29bc00b39d9f15df97e64a8456
MD5 ee1e7e29e49fa81005da9b669379cfe4
BLAKE2b-256 7af48aafbc3a906a814cd67051de1888fc69851633b7da9de118d18e30f9491f

See more details on using hashes here.

File details

Details for the file okrand-1.3.0-py2.py3-none-any.whl.

File metadata

  • Download URL: okrand-1.3.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 29.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for okrand-1.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d33ff6988073dab6f398a81f769f3a39c63ee57a6eaf8f77de9bc9c06e9dd64f
MD5 d886cb55515bc0118d1cc722894da9bf
BLAKE2b-256 932f4653a5afa67a8e36174863e5f9e91a07102fff570dca4ff7a116f9bc721c

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 Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page