An extension for Wagtail Localize that integrates with the Smartling translation platform.
Install the package from PyPI:
python -m pip install wagtail-localize-smartling
Add "wagtail_localize_smartling"
to INSTALLED_APPS
in your Django
settings. Make sure it's before "wagtail_localize"
and
"wagtail_localize.locales"
:
INSTALLED_APPS = [
...
"wagtail_localize_smartling",
"wagtail_localize",
"wagtail_localize.locales",
...
]
Configure the plugin in your Django settings:
WAGTAIL_LOCALIZE_SMARTLING = {
# Required settings (get these from "Account settings" > "API" in the Smartling dashboard)
"PROJECT_ID": "<project_id>",
"USER_IDENTIFIER": "<user_identifier>",
"USER_SECRET": "<user_secret>",
# Optional settings and their default values
"REQUIRED": False, # Set this to True to always send translations to Smartling
"ENVIRONMENT": "production", # Set this to "staging" to use Smartling's staging API
"API_TIMEOUT_SECONDS": 5.0, # Timeout in seconds for requests to the Smartling API
}
If your project's locales do not match those in Smartling (e.g. ro
in your
project, ro-RO
in Smartling), then you can provide a Wagtail locale ID to
Smartling locale ID mapping via the LOCALE_TO_SMARTLING_LOCALE
setting:
WAGTAIL_LOCALIZE_SMARTLING = {
"LOCALE_TO_SMARTLING_LOCALE": {
"ro": "ro-RO"
}
}
... or you can specify a callable or a dotted path to a callable in the
LOCALE_MAPPING_CALLBACK
setting:
def map_project_locale_to_smartling(locale: str) -> str:
if locale == "ro":
return "ro-RO"
return locale
WAGTAIL_LOCALIZE_SMARTLING = {
# ...
"LOCALE_MAPPING_CALLBACK": "settings.map_project_locale_to_smartling"
}
The callback receives a WAGTAIL_CONTENT_LANGUAGES
local code string and is
expected to return a valid mapped locale ID (or the original locale ID).
Note that by default, when syncing translations the project will attempt to
reformat a mixed-case, Smartling-style language code (e.g. zh-CN
) into a
Django-style all-lowercase code (e.g. zh-cn
). Depending on how language
codes are set up in your project, this behaviour may not be appropriate. You
can disable it by settings the REFORMAT_LANGUAGE_CODES
setting to False
(the default is True
):
WAGTAIL_LOCALIZE_SMARTLING = {
# ...
"REFORMAT_LANGUAGE_CODES": False
}
Run migrations:
./manage.py migrate
For the plugin to work with a Smartling project, the Django/Wagtail internationalization- and localization-related settings must be compatible with the project's language settings:
WAGTAIL_CONTENT_LANGUAGES
should be the exact, case-insensitive matches for the Smartling projects target locales. For example, if your Smartling project targets fr-FR
, then you must have "fr-fr"
in your WAGTAIL_CONTENT_LANGUAGES
, not just "fr"
.
However, if that is not possible, use the LOCALE_TO_SMARTLING_LOCALE
or LOCALE_MAPPING_CALLBACK
settings to map your Wagtail language codes to the Smartling language codes.The plugin provides a sync_smartling
management command that:
This command should be set to run periodically via cron
or similiar:
./manage.py sync_smartling
We recommend running this regularly, around once every 10 minutes.
As well as the sync_smartling
management command, the plugin sets the callbackUrl
field on the Smartling jobs it creates to the URL of webhook handler view. This handler will proactively download and apply translations from completed jobs without waiting for the next sync_smartling
run. This URL is based on the WAGTAILADMIN_BASE_URL
setting, so it's important that's set and accessible from the internet.
[!WARNING] Callbacks should not be relied on as the only method for downloading translations. Always make sure the
sync_smartling
command is run regularly to ensure your translations are up-to-date.
flowchart LR
submitPageForTranslation["Page submitted for translation in Wagtail"]
submitToSmartling{"
User choses to submit
translation job to Smartling?
"}
enterSmartlingJobConfig["User enters Smartling job config"]
pendingSmartlingJobCreated["A pending Smartling job is created in Wagtail"]
wagtailSyncedTranslationEditView["
User is redirected to Wagtail's
synced translation edit view
"]
submitPageForTranslation-->submitToSmartling
submitToSmartling-->|Yes|enterSmartlingJobConfig
enterSmartlingJobConfig-->pendingSmartlingJobCreated
pendingSmartlingJobCreated-->wagtailSyncedTranslationEditView
submitToSmartling-->|No|wagtailSyncedTranslationEditView
django-admin sync_smartling
, the below flowchart describes the logic run for each job
flowchart LR
jobSentToSmartling{"Has the job been
sent to Smartling yet?"}
sendJobToSmartling["Send job to Smartling"]
jobFinished{"Is the job finalised?"}
updateJobFromSmartling["Update job from Smartling"]
fin["End"]
jobSentToSmartling-->|Yes|jobFinished
jobSentToSmartling-->|No|sendJobToSmartling
sendJobToSmartling-->fin
jobFinished-->|Yes|fin
jobFinished-->|No|updateJobFromSmartling
This app provides a single wagtail_localize.signals.translation_imported
signal that is sent when translation are imported from Smartling.
Signal kwargs:
sender
: The wagtail_localize_smartling.models.Job
classinstance
: The Job
instance for which translation are being importedtranslation
: The wagtail_localize.models.Translation
instance the translations are being imported to.
Use translation.get_target_instance()
to get the model instance that the translation is for (e.g. a page or snippet)vX.Y.Z
on main
– or make a tag via the GH UI in Step 6. (Remember to push up the new tag if you made it locally, with git push --tags
)