Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README for v10 GA launch #271

Merged
merged 3 commits into from
Aug 21, 2023
Merged

Update README for v10 GA launch #271

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
35bf812
Update README for v10 GA launch
Aug 15, 2023
591c0f3
Update CircleCI config to fix tests
Aug 15, 2023
0d6418f
Add note about use of new driver version
Aug 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 6 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -10,6 +10,8 @@ FaunaDB Python

Python driver for `FaunaDB <https://fauna.com>`_.

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/).

Installation
------------
Expand All @@ -35,7 +37,7 @@ Documentation

Driver documentation is available at https://fauna.github.io/faunadb-python/4.5.0/api/.

See the `FaunaDB Documentation <https://docs.fauna.com/>`__ for a complete API reference, or look in `tests`_
See the `FaunaDB Documentation <https://docs.fauna.com/fauna/v4/api/fql/>`__ for a complete API reference, or look in `tests`_
for more examples.


Expand Down Expand Up @@ -94,7 +96,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 <https://docs.fauna.com/fauna/current/learn/understanding/billing#perquery>`__.
More information on query metrics is available in the `FaunaDB Documentation <https://docs.fauna.com/fauna/v4/learn/understanding/plan_billing/billing#perquery>`__.

Here is a simple example:

Expand Down