Update GCP OAuth Readme #464

edwardfeng-db · 2023-11-29T17:56:21Z

Changes

Previously the style was not consistent with other python sdk authentication documentations, due to some copy paste mistakes from the go sdk. Updating it in this PR

Tests

make test run locally
make fmt applied
relevant integration tests applied

codecov-commenter · 2023-11-29T17:59:25Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8da97de) 51.57% compared to head (ce5030c) 51.57%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #464   +/-   ##
=======================================
  Coverage   51.57%   51.57%           
=======================================
  Files          38       38           
  Lines       22355    22355           
=======================================
  Hits        11530    11530           
  Misses      10825    10825

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pietern

Thanks!

README.md

Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com> Signed-off-by: Edward Feng <67326663+edwardfeng-db@users.noreply.github.com>

Bugfixes: * Fixed accidental rename ([#471](#471)). * Fixed parsing of ISO date strings ([#473](#473)). Other changes: * Updated GCP OAuth Readme ([#464](#464)). * Reference Documentation Refactoring ([#467](#467)). * Installed local library when generating docs ([#469](#469)). * Fixed readme links in pypi ([#472](#472)). * Updated a note for installing Python SDK on Databricks Runtime 13.1+ ([#474](#474)). * Updated GCP auth readme ([#470](#470)). API Changes: * Changed `update()` method for [w.connections](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/connections.html) workspace-level service with new required argument order. * Added `cloudflare_api_token` field for `databricks.sdk.service.catalog.CreateStorageCredential`. * Added `cloudflare_api_token` field for `databricks.sdk.service.catalog.StorageCredentialInfo`. * Changed `name` field for `databricks.sdk.service.catalog.UpdateCatalog` to be required. * Added `new_name` field for `databricks.sdk.service.catalog.UpdateCatalog`. * Changed `name` field for `databricks.sdk.service.catalog.UpdateConnection` to no longer be required. * Added `new_name` field for `databricks.sdk.service.catalog.UpdateConnection`. * Changed `name` field for `databricks.sdk.service.catalog.UpdateExternalLocation` to be required. * Added `new_name` field for `databricks.sdk.service.catalog.UpdateExternalLocation`. * Added `new_name` field for `databricks.sdk.service.catalog.UpdateMetastore`. * Added `new_name` field for `databricks.sdk.service.catalog.UpdateRegisteredModelRequest`. * Added `new_name` field for `databricks.sdk.service.catalog.UpdateSchema`. * Changed `name` field for `databricks.sdk.service.catalog.UpdateStorageCredential` to be required. * Added `cloudflare_api_token` field for `databricks.sdk.service.catalog.UpdateStorageCredential`. * Added `new_name` field for `databricks.sdk.service.catalog.UpdateStorageCredential`. * Added `new_name` field for `databricks.sdk.service.catalog.UpdateVolumeRequestContent`. * Added `cloudflare_api_token` field for `databricks.sdk.service.catalog.ValidateStorageCredential`. * Added `databricks.sdk.service.catalog.CloudflareApiToken` dataclass. * Removed `continuous` field for `databricks.sdk.service.jobs.BaseRun`. * Removed `continuous` field for `databricks.sdk.service.jobs.Run`. * Changed `job_parameters` field for `databricks.sdk.service.jobs.RunJobTask` to `databricks.sdk.service.jobs.ParamPairs` dataclass. * Added `run_if` field for `databricks.sdk.service.jobs.SubmitTask`. * Added `run_job_task` field for `databricks.sdk.service.jobs.SubmitTask`. * Changed `update_config()` method for [w.serving_endpoints](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/serving_endpoints.html) workspace-level service with new required argument order. * Added `put()` method for [w.serving_endpoints](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/serving_endpoints.html) workspace-level service. * Added `rate_limits` field for `databricks.sdk.service.serving.CreateServingEndpoint`. * Changed `served_models` field for `databricks.sdk.service.serving.EndpointCoreConfigInput` to no longer be required. * Added `auto_capture_config` field for `databricks.sdk.service.serving.EndpointCoreConfigInput`. * Added `served_entities` field for `databricks.sdk.service.serving.EndpointCoreConfigInput`. * Added `auto_capture_config` field for `databricks.sdk.service.serving.EndpointCoreConfigOutput`. * Added `served_entities` field for `databricks.sdk.service.serving.EndpointCoreConfigOutput`. * Added `served_entities` field for `databricks.sdk.service.serving.EndpointCoreConfigSummary`. * Added `served_entities` field for `databricks.sdk.service.serving.EndpointPendingConfig`. * Added `extra_params` field for `databricks.sdk.service.serving.QueryEndpointInput`. * Added `input` field for `databricks.sdk.service.serving.QueryEndpointInput`. * Added `max_tokens` field for `databricks.sdk.service.serving.QueryEndpointInput`. * Added `messages` field for `databricks.sdk.service.serving.QueryEndpointInput`. * Added `n` field for `databricks.sdk.service.serving.QueryEndpointInput`. * Added `prompt` field for `databricks.sdk.service.serving.QueryEndpointInput`. * Added `stop` field for `databricks.sdk.service.serving.QueryEndpointInput`. * Added `stream` field for `databricks.sdk.service.serving.QueryEndpointInput`. * Added `temperature` field for `databricks.sdk.service.serving.QueryEndpointInput`. * Changed `predictions` field for `databricks.sdk.service.serving.QueryEndpointResponse` to no longer be required. * Added `choices` field for `databricks.sdk.service.serving.QueryEndpointResponse`. * Added `created` field for `databricks.sdk.service.serving.QueryEndpointResponse`. * Added `data` field for `databricks.sdk.service.serving.QueryEndpointResponse`. * Added `id` field for `databricks.sdk.service.serving.QueryEndpointResponse`. * Added `model` field for `databricks.sdk.service.serving.QueryEndpointResponse`. * Added `object` field for `databricks.sdk.service.serving.QueryEndpointResponse`. * Added `usage` field for `databricks.sdk.service.serving.QueryEndpointResponse`. * Changed `workload_size` field for `databricks.sdk.service.serving.ServedModelInput` to `databricks.sdk.service.serving.ServedModelInputWorkloadSize` dataclass. * Changed `workload_type` field for `databricks.sdk.service.serving.ServedModelInput` to `databricks.sdk.service.serving.ServedModelInputWorkloadType` dataclass. * Added `task` field for `databricks.sdk.service.serving.ServingEndpoint`. * Added `task` field for `databricks.sdk.service.serving.ServingEndpointDetailed`. * Added `databricks.sdk.service.serving.Ai21LabsConfig` dataclass. * Added `databricks.sdk.service.serving.AnthropicConfig` dataclass. * Added `databricks.sdk.service.serving.AutoCaptureConfigInput` dataclass. * Added `databricks.sdk.service.serving.AutoCaptureConfigOutput` dataclass. * Added `databricks.sdk.service.serving.AutoCaptureState` dataclass. * Added `databricks.sdk.service.serving.AwsBedrockConfig` dataclass. * Added `databricks.sdk.service.serving.AwsBedrockConfigBedrockProvider` dataclass. * Added `databricks.sdk.service.serving.ChatMessage` dataclass. * Added `databricks.sdk.service.serving.ChatMessageRole` dataclass. * Added `databricks.sdk.service.serving.CohereConfig` dataclass. * Added `databricks.sdk.service.serving.DatabricksModelServingConfig` dataclass. * Added `databricks.sdk.service.serving.EmbeddingsV1ResponseEmbeddingElement` dataclass. * Added `databricks.sdk.service.serving.EmbeddingsV1ResponseEmbeddingElementObject` dataclass. * Added `databricks.sdk.service.serving.ExternalModel` dataclass. * Added `databricks.sdk.service.serving.ExternalModelConfig` dataclass. * Added `databricks.sdk.service.serving.ExternalModelProvider` dataclass. * Added `databricks.sdk.service.serving.ExternalModelUsageElement` dataclass. * Added `databricks.sdk.service.serving.FoundationModel` dataclass. * Added `databricks.sdk.service.serving.OpenAiConfig` dataclass. * Added `databricks.sdk.service.serving.PaLmConfig` dataclass. * Added `databricks.sdk.service.serving.PayloadTable` dataclass. * Added `databricks.sdk.service.serving.PutRequest` dataclass. * Added `databricks.sdk.service.serving.PutResponse` dataclass. * Added `databricks.sdk.service.serving.QueryEndpointResponseObject` dataclass. * Added `databricks.sdk.service.serving.RateLimit` dataclass. * Added `databricks.sdk.service.serving.RateLimitKey` dataclass. * Added `databricks.sdk.service.serving.RateLimitRenewalPeriod` dataclass. * Added `databricks.sdk.service.serving.ServedEntityInput` dataclass. * Added `databricks.sdk.service.serving.ServedEntityOutput` dataclass. * Added `databricks.sdk.service.serving.ServedEntitySpec` dataclass. * Added `databricks.sdk.service.serving.ServedModelInputWorkloadSize` dataclass. * Added `databricks.sdk.service.serving.ServedModelInputWorkloadType` dataclass. * Added `databricks.sdk.service.serving.V1ResponseChoiceElement` dataclass. * Removed [a.account_network_policy](https://databricks-sdk-py.readthedocs.io/en/latest/account/account_network_policy.html) account-level service. * Removed `databricks.sdk.service.settings.AccountNetworkPolicyMessage` dataclass. * Removed `databricks.sdk.service.settings.DeleteAccountNetworkPolicyRequest` dataclass. * Removed `databricks.sdk.service.settings.DeleteAccountNetworkPolicyResponse` dataclass. * Removed `databricks.sdk.service.settings.ReadAccountNetworkPolicyRequest` dataclass. * Removed `databricks.sdk.service.settings.UpdateAccountNetworkPolicyRequest` dataclass. * Removed `name` field for `databricks.sdk.service.sharing.UpdateCleanRoom`. * Changed `name` field for `databricks.sdk.service.sharing.UpdateProvider` to be required. * Added `new_name` field for `databricks.sdk.service.sharing.UpdateProvider`. * Changed `name` field for `databricks.sdk.service.sharing.UpdateRecipient` to be required. * Added `new_name` field for `databricks.sdk.service.sharing.UpdateRecipient`. * Changed `name` field for `databricks.sdk.service.sharing.UpdateShare` to be required. * Added `new_name` field for `databricks.sdk.service.sharing.UpdateShare`. * Added `statement_ids` field for `databricks.sdk.service.sql.QueryFilter`. * Added `databricks.sdk.service.sql.StatementId` dataclass. OpenAPI SHA: 63caa3cb0c05045e81d3dcf2451fa990d8670f36, Date: 2023-12-12

update

ce5030c

edwardfeng-db requested a review from pietern November 29, 2023 17:56

pietern approved these changes Nov 29, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

7aba39c

Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com> Signed-off-by: Edward Feng <67326663+edwardfeng-db@users.noreply.github.com>

edwardfeng-db added this pull request to the merge queue Nov 29, 2023

Merged via the queue into main with commit a7719a0 Nov 29, 2023
9 checks passed

edwardfeng-db deleted the edwardfeng-db/update-readme branch November 29, 2023 20:15

hectorcast-db mentioned this pull request Dec 12, 2023

Release v0.15.0 #478

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update GCP OAuth Readme #464

Update GCP OAuth Readme #464

edwardfeng-db commented Nov 29, 2023

codecov-commenter commented Nov 29, 2023

pietern left a comment

Update GCP OAuth Readme #464

Update GCP OAuth Readme #464

Conversation

edwardfeng-db commented Nov 29, 2023

Changes

Tests

codecov-commenter commented Nov 29, 2023

Codecov Report

pietern left a comment

Choose a reason for hiding this comment