muffin-babel 0.4.1

No project description provided

Muffin-Babel – an extension to Muffin that adds localization support with help of babel.

Contents

• Requirements

• Installation

• Usage

  • Jinja2

  • Options

• Commands

  • Extract messages

• Bug tracker

• Contributing

• Contributors

• License

Requirements

• python >= 3.5.3

Installation

Muffin-Babel should be installed using pip:

pip install muffin-babel

Usage

Add muffin_babel to PLUGINS in your Muffin application config:

import muffin

app = muffin.Application(
    'example',

    PLUGINS=(
        'muffin_jinja2',
        'muffin_babel',
    )

)

Setup a locale selector function:

@app.ps.babel.locale_selector
def set_locale(request):
    """ Return locale from GET lang-param or automatically. """
    return request.GET.get(
        'lang',

        # Get locale based on user settings
        app.ps.babel.select_locale_by_request(request)
    )

Use app.ps.babel.gettext, app.ps.babel.pgettext, app.ps.babel.lazy_gettext function in your code:

@app.register('/')
def index(request):
    return app.ps.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 in Jinja2 templates’ context.

Note

muffin_jinja2 should be enabled before muffin_babel in your application configuration.

Options

BABEL_CONFIGURE_JINJA2	Install i18n support to Muffin-Jinja2 (True)
BABEL_DEFAULT_LOCALE	Set default locale (en)
BABEL_DOMAIN	Set default domain (messages)
BABEL_LOCALES_DIRS	List of directories where locales are leaving
BABEL_SOURCES_MAP	Babel sources map
BABEL_OPTIONS_MAP	Babel options map

Commands

The plugin adds two commands to your Muffin application.

Extract messages

Extract strings from your application to locales:

$ muffin app_module extract_messages [OPTIONS] appdir

Translate .po files and compile translations:

$ muffin app_module 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.