https://github.com/boxed/okrand

Okrand is an internationalization/translation tool for Django
https://github.com/boxed/okrand

django i18n

Last synced: 2 months ago
JSON representation

Okrand is an internationalization/translation tool for Django

• Host: GitHub
• URL: https://github.com/boxed/okrand
• Owner: boxed
• License: bsd-3-clause
• Created: 2023-01-30T20:04:15.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-12T00:50:57.000Z (4 months ago)
• Last Synced: 2024-10-25T17:06:15.832Z (3 months ago)
• Topics: django, i18n
• Language: Python
• Homepage:
• Size: 149 KB
• Stars: 11
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

        
Okrand

------

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``:

.. code-block::

    [tool:okrand]

    django_model_upgrade=1

So concretely this model:

.. code-block:: python

    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:

.. code-block:: python

    class Book(Model):

        name = CharField()

        isbn = CharField(verbose_name='ISBN')

Note that I 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:

.. code-block:: python

    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

.. code-block::

    [tool:okrand]

    ignore=

        .*some_annoying_path.*

    sort=alphabetical

    django_model_upgrade=1

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``:

.. code-block:: python

    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.