From e08ed1433e6d4eb94b033a84f2a7d8ede67332d8 Mon Sep 17 00:00:00 2001 From: Curtis Bray <7503563+CLBray@users.noreply.github.com> Date: Mon, 21 Aug 2023 07:36:56 -0700 Subject: [PATCH] Update README for v10 GA launch (#271) * Update README for v10 GA launch * Update CircleCI config to fix tests * Add note about use of new driver version --- .circleci/config.yml | 4 ++++ README.rst | 11 +++++++---- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index a77abcb..8e3df0e 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -28,6 +28,10 @@ commands: description: "Run Python tests" steps: - checkout + + - setup_remote_docker: + version: 24.0 + docker_layer_caching: true - run: name: Install codecov diff --git a/README.rst b/README.rst index a64615d..e5d4468 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ -FaunaDB Python -============== +The Official Python driver for v4 API of Fauna +============================================== .. image:: https://img.shields.io/codecov/c/github/fauna/faunadb-python/master.svg?maxAge=21600 :target: https://codecov.io/gh/fauna/faunadb-python @@ -10,6 +10,9 @@ FaunaDB Python Python driver for `FaunaDB `_. +Note: This driver supports an older version of the Fauna API. The latest version of the official +Fauna Python Driver is located [here](https://pypi.org/project/faunadb/) (we encourage all new +development to use this new version where possible). Installation ------------ @@ -35,7 +38,7 @@ Documentation Driver documentation is available at https://fauna.github.io/faunadb-python/4.5.0/api/. -See the `FaunaDB Documentation `__ for a complete API reference, or look in `tests`_ +See the `FaunaDB Documentation `__ for a complete API reference, or look in `tests`_ for more examples. @@ -94,7 +97,7 @@ Observing Metrics Its possible to observe each query's metrics by providing an "observer" callback. -More information on query metrics is available in the `FaunaDB Documentation `__. +More information on query metrics is available in the `FaunaDB Documentation `__. Here is a simple example: