Translation plugin for Wagtail CMS
Project description
Wagtail localize
Wagtail Localize is a translation plugin for the Wagtail CMS. It allows pages or snippets to be translated within Wagtail's admin interface. It also provides integrations with external translations services such as Pontoon or DeepL, and importing/exporting translations with PO files.
Requirements
Wagtail Localize requires the following:
- Python (3.8, 3.9, 3.10, 3.11)
- Django (3.2, 4.1, 4.2)
- Wagtail (4.1, 5.1, 5.2) with internationalisation enabled
- wagtail-modeladmin if
using wagtail_localize.modeladminand Wagtail >= 5.0
Installation
Install using pip:
pip install wagtail-localize
Add wagtail_localize and wagtail_localize.locales to your INSTALLED_APPS setting:
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.
python manage.py collectstatic
Contributing
All contributions are welcome!
Install
To make changes to this project, first clone this repository:
git clone git@github.com:wagtail/wagtail-localize.git
cd wagtail-localize
With your preferred virtualenv activated, install testing dependencies:
Using pip
pip install pip>=21.3
pip install -e '.[testing]' -U
Using flit
pip install "flit>=3.8.0"
flit install
pre-commit
Note that this project uses pre-commit. To set up locally:
# 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:
tox
or, you can run them for a specific environment tox -e python3.8-django3.2-wagtail4.1 or specific test
tox -e python3.9-django3.2-wagtail4.1-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 or ask a question on the #multi-language channel on Wagtail's Slack instance.
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file wagtail_localize-1.8.1.tar.gz.
File metadata
- Download URL: wagtail_localize-1.8.1.tar.gz
- Upload date:
- Size: 281.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2386642818a7bc11a2beb6e00118694481d710e48fee31daeb494d05d23bacca |
|
| MD5 | 703babb91d5984bf86c50777e2d704e4 |
|
| BLAKE2b-256 | cdcd2d314f517db5c8667044edb9d5ab3c85e97f0bdaebce86199ad71e92dfc9 |
Provenance
File details
Details for the file wagtail_localize-1.8.1-py3-none-any.whl.
File metadata
- Download URL: wagtail_localize-1.8.1-py3-none-any.whl
- Upload date:
- Size: 506.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5be1da1056c65572867788ca16e2078b2211a4995c2dd74e49ba1cb4f1d64ab6 |
|
| MD5 | 1352d4d797bffe3c223955bc29d697a9 |
|
| BLAKE2b-256 | b9a72b36985e7be07097024b3c5ac81b5babb71f1f082f9b1282534c07c88327 |
