Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zerolab/wagtail-localize-rws-languagecloud
https://github.com/zerolab/wagtail-localize-rws-languagecloud
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/zerolab/wagtail-localize-rws-languagecloud
- Owner: zerolab
- License: other
- Created: 2021-09-15T08:20:15.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-06T22:17:05.000Z (almost 2 years ago)
- Last Synced: 2023-08-03T20:58:17.282Z (over 1 year ago)
- Language: Python
- Size: 431 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Wagtail Localize RWS LanguageCloud
This allows users of [RWS LanguageCloud](https://www.rws.com/translation/language-cloud/) to translate and localize Wagtail CMS content.
## Requirements
- Python >= 3.7
- Django >= 3.2
- Wagtail >= 2.15
- wagtail-localize >= 1.0.1
## Setup
1. `pip install wagtail-localize-rws-languagecloud`
2. Add `wagtail_localize_rws_languagecloud` to `INSTALLED_APPS` _before_ `wagtail.admin` and `wagtail_localize`:
```python
INSTALLED_APPS = [
# ...
"wagtail_localize_rws_languagecloud",
"wagtail.admin",
"wagtail_localize",
]
```
3. Configure the plugin in Django settings:
```python
import datetime
WAGTAILLOCALIZE_RWS_LANGUAGECLOUD = {
# (required) Authentication details to connect to the LanguageCloud API.
# For info on how to obtain these credentials see https://languagecloud.sdl.com/lc/api-docs/authenticate
"CLIENT_ID": "",
"CLIENT_SECRET": "",
"ACCOUNT_ID": "",
# (required) Identifier of a LanguageCloud template to create projects from
"TEMPLATE_ID": "",
# (required) Identifier of a LanguageCloud location to store project files in
"LOCATION_ID": "",
# (optional) Prefix for project names. Defaults to '' if not specified
"PROJECT_PREFIX": "foobar_",
# (optional) A timedelta object used to set the project 'due by' date.
# Defaults to datetime.timedelta(days=7) if not specified
"DUE_BY_DELTA": datetime.timedelta(days=30),
# (optional) Number of a seconds to sleep between each API request.
# Defaults to 0 if not specified
"API_SLEEP_SECONDS": 5,
# (optional) Send an email to uers with any of the following permissions:
# - wagtail_localize.add_translation
# - wagtail_localize.change_translation
# - wagtail_localize.delete_translation
# - wagtail_localize.submit_translation
# when new translations are ready for review.
# Defaults to False if not specified
"SEND_EMAILS": True,
# (optional) Provide a WAGTAIL_CONTENT_LANGUAGE code to RWS language code map
# RWS expects region codes (e.g. "en-US", "de-DE") whereas Wagtail will happily
# accept two letter lanugage code ("en", "de"). You can also use this mapping
# to map dialect language codes to the main supported language
"LANGUAGE_CODE_MAP": {
"en": "en-US",
"ja": "ja-JP",
"es-mx": "es-ES",
},
}
```
4. Apply migrations:
```
./manage.py migrate
```
## Exporting and importing content to/from LanguageCloud
This plugin works by:
- Identifying text in Wagtail which is pending localization and exporting it to LanguageCloud
- Identifying completed projects in LanguageCloud and importing the localized content back into Wagtail
This is done through a management command:
```
./manage.py sync_rws
```
This command needs to be run on an interval using a scheduler like cron. We recommend an interval of about every 10 minutes.
It is desirable to prevent more than one copy of the sync command from running at the same time.
- If using cron as a scheduler, [lockrun](http://unixwiz.net/tools/lockrun.html) can be used to prevent multiple instance of the same job running simultaneously.
- If using a queue-based scheduler like Celery Beat, the `SyncManager` class contains `is_queued` and `is_running` extension points which could be used to implement a lock strategy.
## Update translated pages
Wagtail Localize comes with a feature called "Sync translated pages" which copies untranslated content from the source page to its translated pages. This is useful when the source page content has been updated and needs to be copied and re-translated.
This plugin comes with an optional management command that automates this process by running sync translated pages on pages with stale translated content.
```
./manage.py update_translated_pages
```
This command:
- Runs "sync translated pages" on pages that have been published but not yet synced.
- Queues these pages to be translated on LanguageCloud using the default settings.
- Sends an email summary with the list of pages that were synced or skipped.
Pages that match the following criteria are excluded from auto-syncing:
- Pages that haven't been translated before.
- Pages that have pending translations on LanguageCloud.
You can use this command ad-hoc, or schedule it to run on an interval to automatically keep translated versions of your content up-to-date.
You can safely preview which pages will be affected without actually updating them by running the command with `--dry-run`.
```
./manage.py update_translated_pages --dry-run
```
## Signals
`translation_imported`
This signal is sent when a translation from RWS LanguageCloud is successfully imported.
**Arguments:**
- **sender:** `LanguageCloudProject`
- **instance:** The specific `LanguageCloudProject` instance.
- **source_object:** The page or snippet instance that this translation is for.
- **translated_object:** The translated instance of the page or snippet.
For more information on signal handlers, see [the Django docs](https://docs.djangoproject.com/en/stable/topics/signals/#connecting-receiver-functions).
There are some more detailed examples of how the `translation_imported` signal can be used to send slack notifications in [slack-notification-examples.md](docs/slack-notification-examples.md).
## How it works
This plugin uses `wagtail-localize` to convert pages into segments and build new pages from translated segments. `wagtail-localize` provides a web interface for translating these segments in Wagtail itself and this plugin plays nicely with that (translations can be made from the Wagtail side too).
Pages/snippets are submitted to LanguageCloud when they are submitted for translation from the default locale. Pages authored in other locales are not supported yet.
## Contributing
All contributions are welcome!
### Install
To make changes to this project, first clone this repository,
then with your preferred virtualenv activated, install testing dependencies:
```shell
make install
```
### pre-commit
Note that this project uses [pre-commit](https://github.com/pre-commit/pre-commit). To set up locally:
```shell
# if you don't have it yet, globally
$ pip install pre-commit
# go to the project directory
$ cd wagtail-localize-rws-languagecloud
# initialize pre-commit
$ pre-commit install
# Optional, run all checks once for this, then the checks will run only on the changed files
$ pre-commit run --all-files
```
### local_settings.py
You can add a `local_settings.py` file next to `settings.py` for any settings that you need when running the project locally.
For example, you might want to set a `NAME` for the SQLite test database so that `--keepdb` works.
```python
# wagtail_localize_rws_languagecloud/test/local_settings.py
from .settings import DATABASES
DATABASES["default"]["TEST"] = {"NAME": "test.db"}
```