From d1d1c1a414ce51fd0d2f128c950715011e96326e Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Thu, 11 May 2023 12:29:32 +0200 Subject: [PATCH] Documentation: Add pointers to executable code examples --- docs/index.rst | 2 ++ examples/README.rst | 9 +++++++++ 2 files changed, 11 insertions(+) create mode 100644 examples/README.rst diff --git a/docs/index.rst b/docs/index.rst index c166b513..27e4752e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -169,6 +169,7 @@ Examples - The :ref:`by-example` section enumerates concise examples demonstrating the different API interfaces of the CrateDB Python client library. Those are DB API, HTTP, and BLOB interfaces, and the SQLAlchemy dialect. +- Executable code examples are maintained within the `cratedb-examples repository`_. - The `sample application`_ and the corresponding `sample application documentation`_ demonstrate the use of the driver on behalf of an example "guestbook" application. @@ -223,6 +224,7 @@ The project is licensed under the terms of the Apache 2.0 license, like .. _CrateDB source: https://github.com/crate/crate .. _Create an issue: https://github.com/crate/crate-python/issues .. _development sandbox: https://github.com/crate/crate-python/blob/master/DEVELOP.rst +.. _cratedb-examples repository: https://github.com/crate/cratedb-examples/tree/main/by-language .. _FIWARE QuantumLeap data historian: https://github.com/orchestracities/ngsi-timeseries-api .. _GeoJSON: https://geojson.org/ .. _GeoJSON geometry objects: https://tools.ietf.org/html/rfc7946#section-3.1 diff --git a/examples/README.rst b/examples/README.rst new file mode 100644 index 00000000..558d412e --- /dev/null +++ b/examples/README.rst @@ -0,0 +1,9 @@ +############################## +CrateDB Python driver examples +############################## + + +Executable code examples are maintained within the `cratedb-examples repository`_. + + +.. _cratedb-examples repository: https://github.com/crate/cratedb-examples/tree/main/by-language