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.

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

Documentation: Add pointers to executable code examples #554

Merged
merged 1 commit into from
Nov 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
9 changes: 9 additions & 0 deletions examples/README.rst
Original file line number Diff line number Diff line change
@@ -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