edX Internationalization Tools
Project description
Installing
EdX i18n tools are a set of commands useful for developers and translators to extract, compile and validate translations. The edX i18n tools can be installed running the following command inside the extracted directory.
python setup.py install
Running
For Django projects, commands should be run from the root directory, and the default configuration will be found at ./conf/locale/config.yaml. For Django apps, commands should be run from the app’s directory, and the default configuration will be found at ./locale/config.yaml.
You can specify a different configuration file with the --config argument.
General Commands
To extract source strings and populate .po translation files with them
i18n_tool extract
To generate test language(eo) translation files from source .po files
i18n_tool dummy
To compile .po translation files into .mo message files
i18n_tool generate
To find translation errors in .po files
i18n_tool validate
To determine if the source translation files(.po) are up-to-date
i18n_tool changed
To segment a .po file into smaller files based on the locations of the messages
i18n_tool segment
Transifex Commands
Developers or translators can use commands provided by edX i18n tools to upload translations to Transifex or download them. Before using these commands one should have an account on transifex.com to create a ~/.transifexrc file. Once the Transifex account has been set up, create a ~/.transifexrc file having these contents:
[https://www.transifex.com] hostname = https://www.transifex.com password = YOURPASSWORD token = username = YOURUSERNAME(EMAIL)
Also make sure you have a Transifex configuration file .tx/config present under the project directory.
To upload translations to Transifex
i18n_tool transifex push
To download translations from Transifex
i18n_tool transifex pull
Configuration
Details of the config.yaml file are in edx-platform/conf/locale/config.yaml
Changes
v0.3.7
A few small fixes for Django projects.
v0.3.6
Major refactoring to enable use on Django apps as well as Django projects.
v0.3.5
Pinned a requirement to prevent failures when used with other applications.
v0.3.4
i18n_tool changed command added. This command determines if the source translation files are up-to-date. If they are not it returns a non-zero exit code.
v0.3.2
i18n_tool validate no longer complains about problems in both the component .po files and the combined .po files.
v0.3.1
i18n_tool extract will preserve existing django.po and djangojs.po files in the source directory.
v0.3
i18n_tool transifex push and i18n_tool transifex pull now can take optional resource names on the command line. If not provided, all resources are pushed/pulled.
v0.2.1
i18n_tool validate no longer leaves an unneeded messages.mo file behind.
Development
To work on this code:
Install Tox:
$ pip install tox
Run tests:
$ tox
If you have failures because msgcat failed, you may need to install it, and adjust your PATH to include it. On a Mac, for example:
$ brew install gettext $ PATH=/usr/local/Cellar/gettext/0.19.3/bin/:$PATH tox
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for edx_i18n_tools-0.3.7-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e515bdb75aebc59e81e3f5e5119860ef6f184683e721d7437d1e6addafd84fd5 |
|
| MD5 | b6c1325523ce01aefa87ec284cf7b1b2 |
|
| BLAKE2b-256 | 4ab99e77247a2b1f931034603556dd644840a6bdb6bc577eb4c80e8f65312d47 |
