Skip to content

Commit

Permalink
Tweak README note about API keys
Browse files Browse the repository at this point in the history
  • Loading branch information
ml-evs committed Mar 12, 2024
1 parent 398ced1 commit 9ceb165
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ pip install git+https://github.com/datalab-industries/datalab-python-api
Currently the only supported authentication method is via an API key.
You can generate one for your account for a given datalab instance by visiting the `/get-api-key` endpoint of your chosen instance, or, if using a recent version of datalab, by visiting your account settings in the browser.

This API key can then be passed directly to the API client, or can be set via the environment variable `DATALAB_API_KEY`.
This API key can be set via the environment variable `DATALAB_API_KEY`.
To suport the use case of needing to interact with multiple datalab instances, the client will also check prefixed environment variables that use the [`IDENTIFIER_PREFIX` of the chosen datalab instance](https://the-datalab.readthedocs.io/en/latest/config/#mandatory-settings), e.g., `GREY_DATALAB_API_KEY` or `PUBLIC_DATALAB_API_KEY`.
Only keys that match will be read (e.g., other environment variables starting with `PUBLIC_` will be ignored, when connecting to the [public demo datalab](https://public.datalab.odbx.science).

Expand Down

0 comments on commit 9ceb165

Please sign in to comment.