A python package to easily translate po and pot files in any language supported by Google Translate.
potranslator is a package to easily translate po and pot files generated by Sphinx or other tools in any language supported by Google Translate.
potranslator auto-detects the language in the original pot files and auto-translates the pot files into the supplied target languages.
The Command Line Interface of potranslator and its documentation are based on sphinx-intl.
Optional: supports the Transifex collaborative service to upload the auto-generated translations to transifex for collaborative corrections of the translations.
Cebuano ceb (ISO-639-2)
Chinese (Simplified) zh-CN (BCP-47)
Chinese (Traditional) zh-TW (BCP-47)
Haitian Creole ht
Hawaiian haw (ISO-639-2)
Hmong hmn (ISO-639-2)
Myanmar (Burmese) my
Nyanja (Chichewa) ny
Portuguese (Portugal, Brazil) pt
Scots Gaelic gd
Sinhala (Sinhalese) si
Tagalog (Filipino) tl
Quick Start for auto-translation with potranslator
This section describes how to translate documents generated by Sphinx with the potranslator command.
Create your document(s) by using Sphinx:
$ sphinx-build -b html /path/to/docs path/to/docs/_build
Optionally add the settings to your conf.py if you have one:
locale_dirs = ['locale/'] #path is an example but this is the recommended path. gettext_compact = False #optional.
locale_dirs is required and gettext_compact is optional.
Extract the document’s translatable messages into pot files (make sure you are in the folder containing make.bat and Makefile if you are on windows):
$ make gettext
Translate/Update your documents in German and Japanese:
$ potranslator update -p _build/gettext -l de -l ja
Done. You got these directories that contain po files with auto-translated entries:
Translate/Update your documents in Japanese, build the compiled mo files and generate the translated html documents:
Command line (for Unix systems):
$ potranslator build $ make -e SPHINXOPTS="-D language='ja'" html
Command line (for Windows cmd.exe):
> set SPHINXOPTS=-D language=de > potranslator build > .\make.bat html
Command line (for PowerShell):
> Set-Item env:SPHINXOPTS "-D language=de" > potranslator build > .\make.bat html
Translate from pot files or update existing po files with auto-generated translation.
Build mo files from translated po or pot files.
Requirements for the basic features
Python 3.6, 3.5, 3.4, 2.7, pypy.
external libraries: setuptools, six, babel, click, googletrans, polib
These features need the transifex-client library.
create a .transifexrc file from an environment variable, without interactive input.
create a .tx/config file without interactive input.
update a .tx/config file from locale/pot files automatically.
build mo files from po files in the locale directory.
You need to use the tx command to use the following features:
tx push -s : push pot (translation catalogs) to transifex.
tx pull -l ja : pull po (translated catalogs) from transifex.
Requirements for the optional features
Your transifex account if you want to upload/download po files from transifex.
external library: transifex-client
It is strongly recommended to use virtualenv for this procedure:
$ pip install potranslator
If you want to use the Optional Features, you need install this additional library:
$ pip install potranslator[transifex]
Commands, options, environment variables
Type potranslator without arguments to show the help instructions.
Setup environment variables
All command-line options can be set with environment variables using the format POTRANSLATOR_<UPPER_LONG_NAME> .
Dashes (-) have to replaced with underscores (_).
For example, to set the target languages:
$ export POTRANSLATOR_LANGUAGE=de,ja
On the Windows command line:
> set POTRANSLATOR_LANGUAGE=de,ja
This is the same as passing the option to potranslator directly:
$ potranslator <command> --language=de --language=ja
Setup sphinx conf.py
Add the following settings to your sphinx document’s conf.py if it exists:
locale_dirs = ['locale/'] #for example gettext_compact = False #optional
Setup Makefile / make.bat
make gettext will generate pot files into the _build/gettext directory, however pot files can be generated in the locale/pot directory if convenient.
You can do that by replacing _build/gettext with locale/pot in your Makefile and/or make.bat that was generated by sphinx-quickstart.
Licensed under the BSD license. See the LICENSE file for specific terms.
The Command Line Interface and the transifex integration of potranslator are adapted from sphinx-intl.
Now uses importlib_ressources for faster startup from CLI.
Updated the command line usability.
Added Type Annotation compliant with PEP 561.
Translated the documentation in French, Spanish, Italian, German, Italian, Japanese and Chinese.
More detailed updates to the po files meta-data.
First release candidate.
Added Command Line Interface.
First release on PyPI.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for potranslator-1.1.5-py2.py3-none-any.whl