Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webu/wagtail-parler
Manage your translations and internationalization with "parler" inside "wagtail" for your custom models (via modeladmin or wagtail snippets) 🧀 🐦
https://github.com/webu/wagtail-parler
cms django parler translation wagtail
Last synced: 3 months ago
JSON representation
Manage your translations and internationalization with "parler" inside "wagtail" for your custom models (via modeladmin or wagtail snippets) 🧀 🐦
- Host: GitHub
- URL: https://github.com/webu/wagtail-parler
- Owner: webu
- License: bsd-3-clause
- Created: 2023-09-12T12:38:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-18T10:54:41.000Z (over 1 year ago)
- Last Synced: 2024-04-25T00:56:26.474Z (9 months ago)
- Topics: cms, django, parler, translation, wagtail
- Language: Python
- Homepage: https://wagtail-parler.readthedocs.io/
- Size: 206 KB
- Stars: 2
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# Wagtail Parler 🧀 🐦
[](https://pypi.org/project/wagtail-parler/)
[](https://github.com/psf/black)
[](https://mypy-lang.org/)
[](https://pycqa.github.io/isort/)
[](https://semver.org/)
[](https://wagtail-parler.readthedocs.io/en/latest/?badge=latest)
Brings "omelette du fromage" 🧀 from parler into wagtail 🐦 for your custom models
(via modeladmin or wagtail snippets)
Wagtail Parler helps you to use `django-parler` inside `wagtail` to translate your customs models.
It works for `wagtail-modeladmin` (which is now deprectaed) and also the new official way:
wagtail's snippets.
## Tests, QA, consistency and compatibility
This app is tested to runs with:
* Django 4.2, 5.0
* Wagtail 5.0, 5.1, 5.2, 6.0, 6.1, 6.2
* Parler 2.3 (probably older ones to, it's just not tested)
* Python 3.9, 3.11
To ensure code quality and consistency:
* Formatted with [black](https://pypi.org/project/black/)
* Validated with [flake8](https://pypi.org/project/flake8/).
* Static types checked with [mypy](https://pypi.org/project/mypy/)
* Tests coverage checked with [coverage](https://pypi.org/project/coverage/) (100% tested)
* Tests runned in local via [tox](https://pypi.org/project/tox/) and on github via [github actions workflow](https://docs.github.com/en/actions/using-workflows)
* versionned with [semver](https://semver.org) logic
## Why
There is already an internationalisation support in wagtail via their own language features
called [wagtail-localize](https://www.wagtail-localize.org/).
This app [also support wagtail modeladmin](https://www.wagtail-localize.org/how-to/modeladmin/).
But the approach of wagtail-localize could be unconvenient as translations are stored in the same
table than "main instances", resulting specific queryset and managers to manage your models.
For app's like treebeard, it can break the logic of your tree.
For those reasons, you could prefer to use `django-parler` as translations approach. Wagtail Parler is fit to you: it will allow you to use
`django-parler` to translate your own models and still have a usefull wagtail interface to
manage translations (via official wagtail's snippet admin but also with the old `wagtail-modeladmin`)
## Installation
Install the package via pip. We consider you already have django-parler and wagtail installed.
`pip install wagtail-parler`
Then, in settings.py, add `wagtail_parler` to the installed apps.
```python
# settings.py
INSTALLED_APPS = [
# …
"wagtail_parler",
# …
]
```
## Basic Usage
You just have to add `ParlerSnippetAdminMixin` to your `SnippetViewSet` (or `ParlerModelAdminMixin` to your `ModelAdmin`), *et voilà*, you are ready to
eat *omelette du fromage*.
```python
from wagtail.snippets.views.snippets import SnippetViewSet
from wagtail.snippets.models import register_snippet
from wagtail_parler.handlers import ParlerSnippetAdminMixin
from .models import Food
class FoodAdmin(ParlerSnippetAdminMixin, SnippetViewSet):
model = Food
register_snippet(FoodAdmin)
# or for an usage with wagtail-modeladmin:
from wagtail_modeladmin.options import ModelAdmin, modeladmin_register
from wagtail_parler.handlers import ParlerModelAdminMixin
from .models import Food
class FoodAdmin(ParlerModelAdminMixin, ModelAdmin):
model = Food
modeladmin_register(FoodAdmin)
```
## Extra 🧀🐦
More advanced usage, tests, etc., are documented [in the doc](https://wagtail-parler.readthedocs.io/).
> Maître [Wagtail][wagtail], sur un arbre perché,
> Tenait en son bec une omelette du fromage.
> Maître [Webu][webu], à l'envie de [parler][parler],
> Lui tint à peu près ce langage :
> Et bonjour, Monsieur [Wagtail][wagtail].
> Que de beaux commits ! quelle merveille !
> Sans mentir, si votre codage
> Se rapporte à votre plumage,
> Vous êtes le Phénix des hôtes de ces dépots.
> …
From « Le Corbeau et le Renard » by Jean de La Fontaine, 1668.
[wagtail]: https://docs.wagtail.org/en/stable/index.html
[parler]: https://django-parler.readthedocs.io/en/stable/index.html
[webu]: https://www.webu.coop