README.md

S-Translation

A package for easy creating and using translated messages with gettext in python projects

Requirements

• gettext installed in your system (gettext)
• python: tested for 3.10, 3.11
• python package python-dotenv (pip install python-dotenv)

Getting started

With .env file

1. First, create a new .env file in your project, eg:

   GETTEXT_DOMAIN=myapp
   LOCALE_DIR=locales  # => directory inside your project base dir to store the gettext translations
   GETTEXT_LANGUAGES='pl,en'
   GETTEXT_LANGUAGE=pl
   

2. Load environment variables from .env file to use above environment variables:

   from dotenv import load_dotenv
   
   load_dotenv()

3. In your code add something with translation e.g.:

   from s_translation import gettext as _
   
   print(_("Hello, world"))

4. Create translations files .po:

   from s_translation import MessageCreator
   
   creator = MessageCreator()
   creator.create_message_files()

5. Next, put your translations to the created files in the previous step ./locales/{language}/LC_MESSAGES/myapp.po e.g. ./locales/pl/LC_MESSAGES/myapp.po.

6. Finally, now generate gettext message object files mo:

   from s_translation import MessageCreator
   
   creator = MessageCreator()
   creator.generate_message_objects()

Without .env file

1. In your code add something with translation e.g.:

   from s_translation import Translation
   
   _ = Translation(domain='myapp', language_code='pl', locale_dir='locales').gettext
   
   print(_("Hello, world"))

2. Create translations files:

   from s_translation import MessageCreator
   
   creator = MessageCreator(domain='myapp', languages=['en', 'pl'], locale_dir='locales')
   creator.create_message_files()

3. Next, put your translations to the created files in the previous step ./locales/{language}/LC_MESSAGES/myapp.po e.g. ./locales/pl/LC_MESSAGES/myapp.po.

4. So, now generate gettext message object files mo:

   from s_translation import MessageCreator
   
   creator = MessageCreator(domain='myapp', languages=['en', 'pl'], locale_dir='locales')
   creator.generate_message_objects()

Now, your gettext translation is ready to use.