summaryrefslogtreecommitdiffstats
path: root/third_party/python/fluent.syntax/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/python/fluent.syntax/README.rst')
-rw-r--r--third_party/python/fluent.syntax/README.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/third_party/python/fluent.syntax/README.rst b/third_party/python/fluent.syntax/README.rst
new file mode 100644
index 0000000000..c847f5e6aa
--- /dev/null
+++ b/third_party/python/fluent.syntax/README.rst
@@ -0,0 +1,22 @@
+``fluent.syntax`` |fluent.syntax|
+---------------------------------
+
+Read, write, and transform `Fluent`_ files.
+
+This package includes the parser, serializer, and traversal
+utilities like Visitor and Transformer. You’re looking for this package
+if you work on tooling for Fluent in Python.
+
+.. code-block:: python
+
+ >>> from fluent.syntax import parse, ast, serialize
+ >>> resource = parse("a-key = String to localize")
+ >>> resource.body[0].value.elements[0].value = "Localized string"
+ >>> serialize(resource)
+ 'a-key = Localized string\n'
+
+
+Find the full documentation on https://projectfluent.org/python-fluent/fluent.syntax/.
+
+.. _fluent: https://projectfluent.org/
+.. |fluent.syntax| image:: https://github.com/projectfluent/python-fluent/workflows/fluent.syntax/badge.svg