From 75a5d8d30850fc54fca42248ad167d7dc1267f9e Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Mon, 1 Apr 2024 10:19:30 -0400 Subject: [PATCH] [DOCS-2618] Note that event streaming is supported in beta --- README.rst | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 26cbe577..58b8438d 100644 --- a/README.rst +++ b/README.rst @@ -11,7 +11,7 @@ of FQL. To query your databases with earlier API versions, see the `faunadb `_ package. See the `Fauna Documentation `_ -for additional information how to configure and query your databases. +for additional information on how to configure and query your databases. Installation @@ -52,7 +52,7 @@ Supported Environment Variables: from fauna.errors import FaunaException client = Client() - # The client defaults to using using the value stored FAUNA_SECRET for its secret. + # The client defaults to using the value stored FAUNA_SECRET for its secret. # Either set the FAUNA_SECRET env variable or retrieve it from a secret store. # As a best practice, don't store your secret directly in your code. @@ -96,7 +96,7 @@ Serialization / Deserialization Serialization and deserialization with user-defined classes is not yet supported. -When building queries, adapt your classes into dicts or lists prior to using them in composition. When instantiating classes from the query result data, build them from the expected result. +When building queries, adapt your classes into dicts or lists before using them in composition. When instantiating classes from the query result data, build them from the expected result. .. code-block:: python @@ -270,10 +270,13 @@ Stats are returned on query responses and ServiceErrors. emit_stats(e.stats) # more error handling... -Document Streaming +Event Streaming ------------------ -Not implemented +`Event Streaming `_ is currently available in the beta version of the driver: + +- `Beta Python driver `_ +- `Beta Python driver docs `_ Setup -----