Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wagtail/wagtail-localize
Translation plugin for Wagtail CMS
https://github.com/wagtail/wagtail-localize
internationalisation wagtail wagtail-package wagtail-plugin
Last synced: 2 months ago
JSON representation
Translation plugin for Wagtail CMS
- Host: GitHub
- URL: https://github.com/wagtail/wagtail-localize
- Owner: wagtail
- License: other
- Created: 2019-04-05T15:21:14.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T18:46:05.000Z (3 months ago)
- Last Synced: 2024-10-08T16:10:11.239Z (3 months ago)
- Topics: internationalisation, wagtail, wagtail-package, wagtail-plugin
- Language: Python
- Homepage: https://wagtail-localize.org/
- Size: 5.69 MB
- Stars: 225
- Watchers: 13
- Forks: 86
- Open Issues: 126
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-wagtail - Wagtail Localize - A translation plugin for the Wagtail CMS, allows pages or snippets to be translated within Wagtail's admin interface. (Apps / Translations)
- stars - wagtail/wagtail-localize - Translation plugin for Wagtail CMS (Python)
- stars - wagtail/wagtail-localize - Translation plugin for Wagtail CMS (Python)
README
# Wagtail localize
[](https://pypi.python.org/pypi/wagtail-localize/)
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://codecov.io/gh/wagtail/wagtail-localize)
[](https://github.com/astral-sh/ruff)
[](https://results.pre-commit.ci/latest/github/wagtail/wagtail-localize/main)
Wagtail Localize is a translation plugin for the [Wagtail CMS](https://wagtail.org). It allows pages or snippets to be translated within Wagtail's admin interface. It also provides integrations with external translations services such as [Pontoon](https://pontoon.mozilla.org/) or [DeepL](https://www.deepl.com/), and importing/exporting translations with PO files.
[Documentation](https://wagtail-localize.org)
[Changelog](https://github.com/wagtail/wagtail-localize/blob/main/CHANGELOG.md)
## Join the Community at Wagtail Space!
We'll be at Wagtail Space US this year! The Call for Participation and Registration for both Wagtail Space 2024 events is open. We would love to have you give a talk, or just us as an attendee in June.
- [Wagtail Space NL](https://nl.wagtail.space/), Arnhem, The Netherlands. 2024-06-14
- [Wagtail Space US](https://us.wagtail.space/), Philadelphia, PA. 2024-06-20 to 2024-06-22
## Requirements
Wagtail Localize requires the following:
- Python (3.9, 3.10, 3.11)
- Django (4.2, 5.0, 5.1)
- Wagtail (5.2, 6.1) with [internationalisation enabled](https://docs.wagtail.org/en/stable/advanced_topics/i18n.html#configuration)
- [wagtail-modeladmin](https://pypi.org/project/wagtail-modeladmin/) if `using wagtail_localize.modeladmin` and Wagtail >= 5.2
## Installation
Install using `pip`:
```shell
pip install wagtail-localize
```
Add `wagtail_localize` and `wagtail_localize.locales` to your `INSTALLED_APPS` setting:
```python
INSTALLED_APPS = [
# ...
"wagtail_localize",
"wagtail_localize.locales", # This replaces "wagtail.locales"
# ...
]
```
`wagtail-localize` loads additional assets for the editing interface. Run the `collectstatic` management command to collect all the required assets.
```shell
python manage.py collectstatic
```
## Contributing
All contributions are welcome!
### Install
To make changes to this project, first clone this repository:
```sh
git clone [email protected]:wagtail/wagtail-localize.git
cd wagtail-localize
```
With your preferred virtualenv activated, install testing dependencies:
#### Using pip
```sh
pip install "pip>=21.3"
pip install -e '.[testing]' -U
```
#### Using flit
```sh
pip install "flit>=3.8.0"
flit install
```
### pre-commit
Note that this project uses [pre-commit](https://github.com/pre-commit/pre-commit). To set up locally:
```shell
# go to the project directory
$ cd wagtail-localize
# 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
```
### How to run tests
Now you can run tests as shown below:
```sh
tox
```
or, you can run them for a specific environment `tox -e python3.11-django4.2-wagtail5.2` or specific test
`tox -e python3.11-django4.2-wagtail5.2-sqlite -- wagtail_localize.tests.test_edit_translation.TestGetEditTranslationView`
To run the test app interactively, use `tox -e interactive`, visit `http://127.0.0.1:8020/admin/` and log in with `admin`/`changeme`.
## Support
For support, please use [GitHub Discussions](https://github.com/wagtail/wagtail-localize/discussions) or ask a question on the `#multi-language` channel on [Wagtail's Slack instance](https://wagtail.org/slack/).
## Thanks
Many thanks to all of our supporters, contributors, and early adopters who helped with the initial release. In particular, to The Mozilla Foundation and Torchbox who sponsored the majority of the initial development and Wagtail core's internationalisation support.