Add examples on how to auth. #179
Conversation
|
|
||
| --- | ||
|
|
||
| Using the freva-client python library |
There was a problem hiding this comment.
non-important - One suggestion from a user perspective to make it easier for them to find what they need: What do you think about separating the Python client and the CLI into new .rst files and displaying them as separate items on the left side of the documentation? Currently, when I click on 'Using the REST API endpoints,' I see the RESTful API, Python client, and CLI all grouped together under RestAPI
| - The **Python client**: via :py:func``freva_client.authenticate`` | ||
| - The **CLI tool**: via ``freva-client auth`` |
There was a problem hiding this comment.
how about directly refer to the topic:
- The **Python client**: via :py:func:`freva_client.authenticate` (Or The **Python client**: via `freva_client.authenticate <Using the freva-client python library_>`_ for details)
- The **CLI tool**: via `freva-client auth <Using the command line interface_>`_|
|
||
| .. literalinclude:: dash_auth_example.py | ||
| :language: python | ||
| :linenos: |
There was a problem hiding this comment.
This comment is not necessary and important at all. I would say, instead of having a written auth python example, it could be cool, if we could offer a jupyter notebook as a binder to users could see the rendered html and run the cells by themselves. But again, it's not necessary
This add an example on who to create custom apps with our auth flow.
@felio92 fyi