Skip to content

Refactor configuration instructions in README #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zhaodongwang-msft merged 2 commits into from
Nov 6, 2025
Merged

Refactor configuration instructions in README #33

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a5f54a
Refactor configuration instructions in README
zhaodongwang-msft Nov 6, 2025
6843a04
Update Auth section with TokenCredential documentation
zhaodongwang-msft Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 6 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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://<yourorg>.crm.dynamics.com/.default` (derived from `base_url`).

## API Reference (Summary)
Expand Down Expand Up @@ -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
Expand Down
Loading