diff --git a/README.md b/README.md index 58222b9..7db08d9 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ A Python package allowing developers to connect to Dataverse environments for DD - Optional pandas integration (`PandasODataClient`) for DataFrame based create / get / query. Auth: -- Accept only an `azure.core.credentials.TokenCredential` credential. +- Accept only an `azure.core.credentials.TokenCredential` credential. See full supported list at https://learn.microsoft.com/en-us/dotnet/api/azure.core.tokencredential?view=azure-dotnet. - Token scope used by the SDK: `https://.crm.dynamics.com/.default` (derived from `base_url`). ## API Reference (Summary) @@ -73,21 +73,16 @@ Direct TDS via ODBC is not used; SQL reads are executed via the Web API using th ## Configuration Notes - For Web API (OData), tokens target your Dataverse org URL scope: https://yourorg.crm.dynamics.com/.default. The SDK requests this scope from the provided TokenCredential. - (Preprod environments may surface newest SQL subset capabilities sooner than production.) -### Configuration (DataverseConfig) - -Pass a `DataverseConfig` or rely on sane defaults: +### Configuration ```python +from azure.identity import InteractiveBrowserCredential from dataverse_sdk import DataverseClient -from dataverse_sdk.config import DataverseConfig - -cfg = DataverseConfig() # defaults: language_code=1033 -client = DataverseClient(base_url="https://yourorg.crm.dynamics.com", config=cfg) -# Optional HTTP tunables (timeouts/retries) -# cfg.http_retries, cfg.http_backoff, cfg.http_timeout +base_url = "https://yourorg.crm.dynamics.com" +credential = InteractiveBrowserCredential() # or DeviceCodeCredential(), ClientSecretCredential(...), etc. +client = DataverseClient(base_url=base_url, credential=credential) ``` ## Quickstart