This is a Python implementation of Project Fluent, a localization framework designed to unleash the entire expressive power of natural language translations.
It provides a different implementation from the official fluent.runtime implementation, distinguished mainly by:
- strategy: we compile FTL files to Python bytecode via AST and use
exec(similar to the strategy used by projects like Mako, Jinja2 and Genshi). - speed: as a result of the above, plus static analysis, we get blazing fast performance, even more so when combined with PyPy which can further optimize.
- compile-time checking and error reporting.
- 'escapers' feature for handling things like HTML escaping/embedding correctly.
To install:
pip install fluent_compiler
See the docs folder or read them on readthedocs.org.
If you are using Django, see django-ftl which wraps the functionality here in Django-specific ways.
See history for a CHANGELOG.
We are not planning major backwards incompatible changes to the interface, but we're also not guaranteeing stability yet. Also, the nature of the library is such that we expect most users will want to create their own wrappers anyway, which you are encouraged to do, in order to be able to absorb any backwards incompatible changes easily.
See the issues list for planned features, and CONTRIBUTING.rst for information about how to contribute, and the architecture docs.
Check out the contributing docs and the architecture notes for information that will help you before you start hacking.
This code was originally developed as part of fluent.runtime, as an
alternative implementation of FluentBundle, but never got merged to the
master branch. It has now been pulled out as a separate package. This is why
the repo's history contains fluent.syntax and early versions of fluent.runtime,
but the parts that are left in this repo all derive from the original version
of fluent.runtime contributed by @spookylukey from a540993a085e36a9679e12f1ee7317ddc1ece5ad onwards and the new compiler implementation in d1481d61e0bc1a28a228a4b6d5258350d436e765 (which is squashed version of work done over a much longer period). Thats why
we also corrected
the copyright notice from Mozilla to Luke Plant.