Add an example notebook on how to use the sdk

[clehensen]

Description
This PR adds a new examples/notebooks directory with a first introduction to python sdk notebook. Reviewing the notebook is a bit inconvenient, maybe we should use nbdime or a differnet tool for that. Otherwise, it's easiest to look at the notebook as a complete file in the code.

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

CC: @fzobel

[github-actions]

Coverage results

Update on 2023-12-06 17:11:08.848487262 +0000

This is the coverage report for commit 1c70e40

Name                                                                                Stmts   Miss  Cover   Missing
-----------------------------------------------------------------------------------------------------------------
.tox/py/lib/python3.12/site-packages/enlyze/__init__.py                                 4      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/api_clients/base.py                        65      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/api_clients/production_runs/client.py      20      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/api_clients/production_runs/models.py      51      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/api_clients/timeseries/client.py           19      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/api_clients/timeseries/models.py           34      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/auth.py                                    13      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/client.py                                  86      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/constants.py                                6      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/errors.py                                   3      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/models.py                                 108      0   100%
.tox/py/lib/python3.12/site-packages/enlyze/validators.py                              38      0   100%
-----------------------------------------------------------------------------------------------------------------
TOTAL                                                                                 447      0   100%

4 empty files skipped.

[daniel-k]

Really nice, I can image very well that this will help our customers to easily get started! 🎉 Most of my comments/suggestions are minor capitalization changes.

[daniel-k]

Please mention the notebook from somewhere in the docs, potentially also in the README. This file should be easily discoverable.

[clehensen]

Please mention the notebook from somewhere in the docs, potentially also in the README. This file should be easily discoverable.

I added a reference to the README, how do I add it to the docs?

[daniel-k]

how do I add it to the docs?

Please have a look at https://github.com/enlyze/enlyze-python/tree/master/docs, the docs are built and published automatically from here on every release.

I'd say we could add a new top level section Examples after Quickstart or put at the end of the Quickstart section.

[clehensen]

Examples are added to the docs now: e798d3a

@daniel-k let me know what you think

[daniel-k]

Thanks for adding references in the docs and the README. Good to go from side 🚀