Localization support for the Muffin Framework
Project description
Muffin-Babel – an extension to Muffin that adds localization support with help of Babel.
Requirements
python >= 3.7
Installation
Muffin-Babel should be installed using pip:
pip install muffin-babel
Usage
Initialize and setup the plugin:
import muffin
import muffin_babel
# Create Muffin Application
app = muffin.Application('example')
# Initialize the plugin
# As alternative: babel = muffin_babel.Plugin(app, **options)
babel = muffin_babel.Plugin()
babel.setup(app, template_folders=['src/templates'])
# Use it inside your handlers
@app.route('/')
async def index(request):
# Get current locale
assert babel.current_locale
# Translate a text
return babel.gettext('Hello World!')Setup a locale selector function (by default the plugin is parsing accept-language header):
@babel.locale_selector
async def get_locale(request):
""" Return locale either from request.query or from request headers. """
locale = request.query.get('lang')
if not locale:
return await muffin_babel.select_locale_by_request(request, default)
return localeUse babel.gettext, babel.pgettext callables in your code:
@app.route('/')
def index(request):
return babel.gettext('Hello!')Jinja2
The Muffin-Babel has integration with Muffin-Jinja2, so if you have muffin_jinja2 plugin enabled, the plugin provides gettext and ngettext function inside the Jinja2 templates’ context.
Options
Name |
Default Value |
Description |
|---|---|---|
AUTO_DETECT_LOCALE |
True |
Installs a middleware to automatically detect users locales |
CONFIGURE_JINJA2 |
True |
Installs i18n support for jinja2 templates (through muffin-jinja) |
DEFAULT_LOCALE |
"en" |
Default locale |
DOMAIN |
"messages" |
Default localization domain |
SOURCES_MAP |
Babel sources map |
|
OPTIONS_MAP |
Babel options map |
You are able to provide the options when you are initiliazing the plugin:
babel.setup(app, default_locale='fr')Or setup it inside Muffin.Application config using the BABEL_ prefix:
BABEL_DEFAULT_LOCALE = 'fr'Muffin.Application configuration options are case insensitive
Commands
The plugin adds two commands to your Muffin application.
Extract messages
Extract strings from your application to locales:
$ muffin app_package babel_extract_messages [OPTIONS] appdir
Translate .po files and compile translations:
$ muffin app_package babel_compile_messages [OPTIONS]
Bug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/muffin-babel/issues
Contributing
Development of Muffin-Babel happens at: https://github.com/klen/muffin-babel
Contributors
klen (Kirill Klenov)
License
Licensed under a MIT license.
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 muffin-babel-1.2.0.tar.gz.
File metadata
- Download URL: muffin-babel-1.2.0.tar.gz
- Upload date:
- Size: 7.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 234dd816317bce75383010c06a3bc0693223bb03663a761c44062d33d0b7f7ad |
|
| MD5 | c25fc6a48fd9b1eb7bdc6acce4aca29a |
|
| BLAKE2b-256 | d19b0b0c9471ed88c24c5f629dc25454e3a9ac7166ec0466e8f677099621d9ed |
File details
Details for the file muffin_babel-1.2.0-py3-none-any.whl.
File metadata
- Download URL: muffin_babel-1.2.0-py3-none-any.whl
- Upload date:
- Size: 6.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 88df8b25f9661a21661b5575d070c08e03046afc248e4cd1e2b507092e3942dc |
|
| MD5 | ff38b1d533e4d3c2c9151983234cb199 |
|
| BLAKE2b-256 | bd4318f9510a8d3aacebfe2a9640ebf32c9456dd0ecb5f2791eac6ba0a00c8d7 |
