Skip to main content

Translation plugin for Wagtail CMS

Project description

Wagtail localize

Version License codecov Ruff pre-commit.ci status

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.

Documentation Changelog

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.

Requirements

Wagtail Localize requires the following:

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.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 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.

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

wagtail_localize-1.9.1.tar.gz (272.0 kB view details)

Uploaded Source

Built Distribution

wagtail_localize-1.9.1-py3-none-any.whl (494.9 kB view details)

Uploaded Python 3

File details

Details for the file wagtail_localize-1.9.1.tar.gz.

File metadata

  • Download URL: wagtail_localize-1.9.1.tar.gz
  • Upload date:
  • Size: 272.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for wagtail_localize-1.9.1.tar.gz
Algorithm Hash digest
SHA256 d7b1434e765a004ffd7b5951d151b3817bbbd1ee5c4f11b9485c84e520f383e6
MD5 ea182a5bb41975840e645a92bda08bf2
BLAKE2b-256 ac3e6a274ebeccf24f305368daa0d945782a28309bf785fd4ce854cb0307776e

See more details on using hashes here.

Provenance

File details

Details for the file wagtail_localize-1.9.1-py3-none-any.whl.

File metadata

File hashes

Hashes for wagtail_localize-1.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c895efc286970d2810929056044c11ff0b4ebb7a26b494d052a07c41ead4afab
MD5 81d9202302ba58516ecf78d002d3d262
BLAKE2b-256 7be29d2a51b3fc103642a176924bd2ef826d0b92c0ac0184aa09dc6fab3c2643

See more details on using hashes here.

Provenance

Supported by

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