Add example notebook intro to enlyze python sdk (#32)

**Description** This PR adds a new `examples/notebooks` directory with a first introduction to python sdk notebook. It also updates the docs and README with links to the example folder. The notebook covers the basic steps from * installing required packages, * using the different methods of the SDK to query data, * explore and visualize data to * saving data in different formats
enlyze · Dec 7, 2023 · e79438d · e79438d
1 parent bf1a82d
commit e79438d
Show file tree

Hide file tree

Showing 7 changed files with 2,966 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -129,3 +129,6 @@ dmypy.json
 .pyre/
 
 .vscode/
+
+# Mac OS-specific storage files
+.DS_Store
diff --git a/README.rst b/README.rst
@@ -64,3 +64,9 @@ so:*
 .. code-block:: console
 
     $ export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib
+
+
+Examples
+--------------------------------
+You can find examples of how to use the Python SDK here: `Notebooks <examples/notebooks>`_
+
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,7 +33,7 @@
 ]
 
 templates_path = ["_templates"]
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".ipynb_checkpoints"]
 
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -0,0 +1,7 @@
+Examples
+========
+In our examples section, you can find Jupyter Notebooks and other material to help you get started:
+
+`Notebooks <https://github.com/enlyze/enlyze-python/tree/master/examples/notebooks>`_:
+
+* `Introduction to the ENLYZE Python SDK <https://github.com/enlyze/enlyze-python/tree/master/examples/notebooks/introduction_enlyze_python_sdk.ipynb>`_
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,6 +14,7 @@ User's Guide
 
     installation
     quickstart
+    examples
     concepts
     client
     models

diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
@@ -21,3 +21,4 @@ url
 uuid
 virtualenv
 whitespace
+Jupyter
-Original file line number
+Diff line change
@@ Expand Up / @@ -21,3 +21,4 @@ url @@
     uuid
     virtualenv
     whitespace
+    Jupyter