Skip to main content

Translate en/messages.json (chrome.i18n format) to 100+ locales automatically.

Project description

> translate-messages

Translate en/messages.json (chrome.i18n format) to 100+ locales automatically.

Installation

pip install translate-messages

Usage

Run the CLI:

translate-messages [options] # or translate-msgs

If no options are passed, the CLI will:

  1. Prompt for message keys to ignore
  2. Auto-discover closest child _locales dir
  3. Translate found en/messages.json to target languages

Note: Any messages.json in the chrome.i18n format can be used as a source file.

Options

Options can be set by using command-line arguments:

Option Description Example
-d, --locales-dir Name of the folder containing locale files (default: _locales) --locales-dir=_messages
-t, --target-langs Comma-separated list of languages to translate to (default: all 100+ stable_locales) --target-langs=es,fr
-k, --keys Comma-separated list of keys to translate (default: all found src keys missing in target files) --keys=app_DESC,err_NOT_FOUND
--exclude-langs Comma-separated list of languages to exclude --exclude-langs=es,zh
--exclude-keys Comma-separated list of keys to ignore --exclude-keys=app_NAME,author
--only-stable Only use stable locales (skip auto-discovery)
--config Use custom config file --config=path/to/file
init, -i, --init Create .translate-msgs.config.json5 in project root to store default options
-f, --force Force overwrite of existing config file when using init
-n, --no-wizard Skip interactive prompts during start-up
-h, --help Show help screen
-v, --version Show version
-V, --debug [targetConfigKey] Show debug logs
--docs Open docs URL

Examples

Translate all keys except app_NAME from _locales/en/messages.json to all stable_locales:

translate-messages --ignore-keys=app_NAME  # prompts for more keys to ignore

Translate app_DESC key from messges/en/messages.json to French:

translate-messages -n --keys=app_DESC --locales-dir=messages --target-langs=fr  # no prompts

Translate app_DESC + err_NOT_FOUND keys from _msgs/en/messages.json to Spanish and Hindi:

translate-msgs -n -k app_DESC,err_NOT_FOUND -d _msgs -t es,hi  # no prompts

Config file

Run translate-msgs init to create .translate-msgs.config.json5 in your project root to set default options.

Example defaults:

{
  "locales_dir": "_locales", // name of the folder containing locale files
  "target_langs": "",        // languages to translate to (e.g. "en,es,fr") (default: all 100+ supported locales)
  "keys": "",                // keys to translate (e.g. "app_DESC,err_NOT_FOUND")
  "exclude_langs": "",       // languages to exclude (e.g. "en,es")
  "exclude_keys": "",        // keys to ignore (e.g. "app_NAME,author")
  "force": false,            // force overwrite existing config file when using init
  "no_wizard": false         // skip interactive prompts during start-up
}

Note: CLI arguments always override config file.

MIT License

Copyright © 2023–2026 Adam Lui.

Back to top ↑

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

translate_messages-1.8.0.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

translate_messages-1.8.0-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file translate_messages-1.8.0.tar.gz.

File metadata

  • Download URL: translate_messages-1.8.0.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for translate_messages-1.8.0.tar.gz
Algorithm Hash digest
SHA256 d3deaa075a2b2985eff627e82ffbc4d7b39f54203aec13119507e8af474aca32
MD5 47f6066ca2adb6983f6aa34f800fecd1
BLAKE2b-256 c63014d41d946ca56f6f13a7854ce6fb98f8d4ec349b035d08aa7f59dac332ab

See more details on using hashes here.

File details

Details for the file translate_messages-1.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for translate_messages-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1377d62846e47dc2726128582c1a5b98084402303771ea230e2979bafd963682
MD5 e404fb39755ffe602787bd29a40e76b8
BLAKE2b-256 7bf212cd41ac5dc474737f25701c9b6e6fa323f8aab4a2cefbc8d2dcb78eec57

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page