ftw.recipe.translations 1.1.0

Installation and configuration

For installation simply use the zc.buildout recipe ftw.recipe.translations:package:

[buildout]
parts = i18n-build

[i18n-build]
recipe = ftw.recipe.translations:package
package-name = my.package

Options:

package-name

The setuptools-name of the package (required).

i18n-domain

The name of the primary domain of this package (optional, defaults to the package name).

package-namespace

The package namespace used for scanning the code when rebuilding the primary domain (optional, defaults to the the package name).

Full example:

[buidlout]
parts = i18n-build

[i18n-build]
recipe = ftw.recipe.translations:package
package-name = MyPackage
i18n-domain = mypackage
package-namespace = my.package

Usage

Rebuilding and syncing all existing languages:

$ bin/i18n-build
Rebuilding .../my/package/locales/mypackage.pot
.../my/package/locales/de/LC_MESSAGES/mypackage.po: 0 added, 2 removed
.../my/package/locales/en/LC_MESSAGES/mypackage.po: 1 added, 2 removed
.../my/package/locales/de/LC_MESSAGES/plone.po: 1 added
.../my/package/locales/en/LC_MESSAGES/plone.po: 1 added

Creating translations (.po-files) for new languages:

$ bin/i18n-build fr it
Rebuilding .../my/package/locales/mypackage.pot
.../my/package/locales/de/LC_MESSAGES/mypackage.po: 0 added, 2 removed
.../my/package/locales/en/LC_MESSAGES/mypackage.po: 1 added, 2 removed
.../my/package/locales/fr/LC_MESSAGES/mypackage.po: 80 added, 0 removed
.../my/package/locales/it/LC_MESSAGES/mypackage.po: 80 added, 0 removed
.../my/package/locales/de/LC_MESSAGES/plone.po: 1 added
.../my/package/locales/en/LC_MESSAGES/plone.po: 1 added
.../my/package/locales/fr/LC_MESSAGES/plone.po: 3 added, 0 removed
.../my/package/locales/it/LC_MESSAGES/plone.po: 3 added, 0 removed

Installation and Configuration

Using the buildout recipe generates a script bin/masstranslate:

[buildout]
parts = translations

[translations]
recipe = ftw.recipe.translations
spreadsheet = https://docs.google.com/spreadsheet/ccc?key=0AgoYEZSDYCg1dEZvVGFTRUc3RDd6123DAFDER

The generated bin/masstranslate script is preconfigured with the configured spreadsheet url and applies to all .po-files in the ./src directory by default.

Google authentication and authorization

Google auth is implemented using OAuth2. This means you require to have an application set up in your Google API Console or at least have the application secrets (.json) of such an application. The application secrets need to be copied to ~/.buildout/ftw.recipe.translations.json. For instructions for creating a Google application see the Wiki page.

When using the upload and download commands, the OAuth2 authentication is done with the configure application. The browser is opened and the user can grant access for the application to his Google Drive. The received ticket is stored in the users keyring / keychain.

The sync command

The bin/masstranslate script provides a sync command for rebuilding primary-domain .pot-files and syncing them with all languages.

As primary domain the package name (folder in the src directory) is expected. Primary domains are rebuilt (the package is searched for translatable strings) and [domain]-manual.pot-files in the locales directory are automatically merged. Non-primary domains are never rebuilt and expected to be updated manually.

All domains are then sync to all existing languages.

Example:

./bin/masstranslate sync

Creating new languages for all packages and domains is as easy as passing a positional argument:

./bin/masstranslate sync de

The upload command

With the upload command translations can easily be extracted from the .po-Files and uploaded into a Google spreadsheet. The upload command always creates a new worksheet in the Google spreadsheet, so that existing data is never overwritten.

See the Configuration section on how to configure the spreadsheet URL.

With positional arguments the languages to be translated can be specificied. Each defined language is included in the spreadsheet. If a message is translated in all languages, the message is not uploaded unless the --all keyword is used.

Additional languages, which are not checked for existing translations, can be added using the --additional-languages keyword, those may be useful for the translator.

Example:

./bin/masstranslate upload de fr --additional-languages en es
Spreadsheet: https://docs.google.com/spreadsheet/ccc?key=0AgoYEZ....
Loading translations
Starting Upload
1 of 191 (0%): Upload
9 of 191 (4%): Upload
...
Finished Upload
Uploaded into worksheet "013: 2014-01-31"

The download command

The download command syncs translations back from the spreadsheet into the .po-files in the source directory. When starting a download, the user is asked for the worksheet and languages to download. When a message is not translated in the spreadsheet, it is never updated in the .po-file.

Example:

./bin/masstranslate download
Please select a worksheet to download:
[1] 011: 2014-01-31
[2] 012: 2014-01-31
[3] 013: 2014-01-31

Please enter the spreadsheet number: 1
Please select the languages to synchronize:
- de
- fr

Enter one language code at a time, finish selection with an empty enter.
Language: fr
Language:

1.1.0 (2014-03-05)

• Implement new bin/i18n-build recipe and script. [jone]

• Rename bin/translations to bin/masstranslate. [jone]

1.0.2 (2014-01-31)

• Fix previous brown bag releases: make buildout recipe work. [jone]

1.0.1 (2014-01-31)

• Fix missing distribution buildout error. [jone]

1.0.0 (2014-01-31)

• Initial implementation. [jone]