|
1 | | -Project Fluent [![Build Status][travisimage]][travislink] |
2 | | -========================================================= |
3 | | - |
4 | | -[travisimage]: https://travis-ci.org/projectfluent/python-fluent.svg?branch=master |
5 | | -[travislink]: https://travis-ci.org/projectfluent/python-fluent |
| 1 | +Project Fluent |
| 2 | +============== |
6 | 3 |
|
7 | 4 | This is a Python implementation of Project Fluent, a localization framework |
8 | 5 | designed to unleash the entire expressive power of natural language |
@@ -32,36 +29,28 @@ you're a tool author you may be interested in the formal [EBNF grammar][]. |
32 | 29 | [Read the Fluent Syntax Guide]: http://projectfluent.org/fluent/guide/ |
33 | 30 | [EBNF grammar]: https://github.com/projectfluent/fluent/tree/master/spec |
34 | 31 |
|
35 | | - |
36 | | -Installation |
37 | | ------------- |
38 | | - |
39 | 32 | python-fluent consists of these packages: |
40 | 33 |
|
41 | | -* `fluent.syntax` - includes AST classes and parser. Most end users will not |
42 | | - need this directly. Documentation coming soon! |
43 | | - |
44 | | - To install: |
45 | | - |
46 | | - pip install fluent.syntax |
47 | | - |
48 | | - |
49 | | -* `fluent.runtime` - methods for generating translations from FTL files. |
50 | | - |
51 | | - To install: |
| 34 | +`fluent.syntax`  |
| 35 | +------------------------------------------------------------------------------------------------------------------------- |
52 | 36 |
|
53 | | - pip install fluent.runtime |
| 37 | +The syntax package includes the parser, serializer, and traversal utilities |
| 38 | +like Visitor and Transformer. You're looking for this package if you work on tooling |
| 39 | +for Fluent in Python. |
54 | 40 |
|
55 | | - (The correct version of ``fluent.syntax`` will be installed automatically) |
56 | 41 |
|
57 | | -* `fluent.pygments` - a plugin for pygments to add syntax highlighting to Sphinx. |
| 42 | +`fluent.runtime`  |
| 43 | +--------------------------------------------------------------------------------------------------------------------------- |
58 | 44 |
|
59 | | - To install: |
| 45 | +This package includes the library required to use Fluent to localize your |
| 46 | +Python application. It comes with a `Localization` class to use, based on |
| 47 | +an implementation of bundle. It uses the tooling parser above to read |
| 48 | +Fluent files. |
60 | 49 |
|
61 | | - pip install fluent.pygments |
| 50 | +`fluent.pygments` |
| 51 | +----------------- |
62 | 52 |
|
63 | | -PyPI also contains an old `fluent` package which is an older version of just |
64 | | -`fluent.syntax`. |
| 53 | +A plugin for pygments to add syntax highlighting to Sphinx. |
65 | 54 |
|
66 | 55 | Usage |
67 | 56 | ----- |
|
0 commit comments