Skip to content

Commit

Permalink
docs: switch quickstart note to warning
Browse files Browse the repository at this point in the history
  • Loading branch information
nodegard committed Sep 4, 2024
1 parent 822f17a commit 8e6e578
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,15 @@ this quickstart we'll demonstrate the most common/recommended patterns. More det
section: :ref:`CogniteClient <class_client_CogniteClient>`, :ref:`ClientConfig <class_client_ClientConfig>`,
:ref:`GlobalConfig <class_client_GlobalConfig>`, and :ref:`credential_providers:Credential Providers`.

.. warning::
Ensure that credentials are stored and handled securely by not hard-coding it or storing them in a text file. All the below examples
are using and referencing environment variables to store this sensitive information.

Instantiate a new client from a configuration file
--------------------------------------------------
Use this code to instantiate a client using a configuration file in order to execute API calls to Cognite Data Fusion (CDF).

.. warning::
.. note::
How you read in the configuration file is up to you as the :ref:`CogniteClient <class_client_CogniteClient>` load method
accepts both a dictionary and a YAML/JSON string. So for the purposes of this example, we will use the yaml library to read in a yaml file and
substitute environment variables in the file string to ensure that sensitive information is not stored in the file.
Expand Down

0 comments on commit 8e6e578

Please sign in to comment.