client(dataall_url=...): connect from the data.all front page, 0.6.0 (#56)

* Document client(dataall_url=...) and require dataall-core 0.6.0

The SDK passes dataall_url through to DataallClient.client, which now
discovers and saves the profile from the data.all front page. Version
0.6.0 (also fixes __version__, which still said 0.3.0a1).

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* Lock dataall-core 0.6.0

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>

Author: TejasRGitHub

README.md

@@ -26,6 +26,9 @@ import dataall_sdk
 # Profile w/ UserA (assuming UserA profile configured in ~/.dataall/config.yaml)
 da_client = dataall.client(profile="UserA") 
 
+# Or discover the settings from the data.all front page (profile saved under its host name)
+da_client = dataall.client(dataall_url="https://DATAALL_DOMAIN_URL")
+
 list_org_response = da_client.list_organizations()
 print(list_org_response)
 ```

dataall_sdk/__metadata__.py

@@ -7,5 +7,5 @@
 
 __title__: str = "dataall_sdk"
 __description__: str = "AWS Dataall SDK"
-__version__: str = "0.3.0a1"
+__version__: str = "0.6.0"
 __license__: str = "Apache License 2.0"

poetry.lock

@@ -1,6 +1,6 @@
 [project]
 name = "dataall-sdk"
-version = "0.4.3"
+version = "0.6.0"
 description = "AWS data.all SDK"
 authors = [{ name = "Amazon Web Services" }]
 license = { text = "Apache License 2.0" }
@@ -20,7 +20,7 @@ dependencies = [
     "packaging>=24.2",
     "build>=0.10.0,<1.0.0",
     "setuptools; python_version >= '3.12'",
-    "dataall-core>=0.4.3",
+    "dataall-core>=0.6.0,<0.7.0",
 ]
 
 [tool.poetry]

pyproject.toml

@@ -1,8 +1,10 @@
 import os
 from unittest.mock import patch
 
+import pytest
 from dataall_core.base_client import BaseClient
 from dataall_core.dataall_client import DataallClient
+from dataall_core.exceptions import MissingParametersException
 from dataall_core.profile import get_profile
 
 import dataall_sdk
@@ -75,3 +77,48 @@ def test_default_client_loaded_methods():
                 {},
             )
             assert getattr(client, method).__doc__ == op_dict[method]["docstring"]
+
+
+OIDC_DISCOVERY = {
+    "frontend_url": "https://dataall.example.com",
+    "auth_type": "OidcBrowserAuth",
+    "idp_domain_url": "https://idp/oauth2/aus1",
+    "client_id": "0oaCLIENT",
+    "api_endpoint_url": "https://api/prod",
+}
+
+
+def test_client_from_frontend_url(tmp_path):
+    config_path = str(tmp_path / "config.yaml")
+    with patch(
+        "dataall_core.discovery.discover_from_frontend",
+        side_effect=lambda url: dict(OIDC_DISCOVERY),
+    ) as discover:
+        client = dataall_sdk.client(
+            dataall_url="https://dataall.example.com/console", config_path=config_path
+        )
+        assert isinstance(client, BaseClient)
+        assert type(client.authorizer).__name__ == "OidcBrowserAuth"
+        assert client.authorizer.profile.profile_name == "dataall.example.com"
+        assert client.authorizer.profile.client_id == "0oaCLIENT"
+        assert client.authorizer.profile.frontend_url == "https://dataall.example.com"
+
+        again = dataall_sdk.client(
+            dataall_url="https://dataall.example.com", config_path=config_path
+        )
+        assert again.authorizer.profile == get_profile(
+            "dataall.example.com", config_path=config_path
+        )
+        discover.assert_called_once()
+
+
+def test_client_from_frontend_url_missing_values(tmp_path):
+    with patch(
+        "dataall_core.discovery.discover_from_frontend",
+        return_value={"frontend_url": "https://dataall.example.com"},
+    ):
+        with pytest.raises(MissingParametersException, match="auth_type"):
+            dataall_sdk.client(
+                dataall_url="https://dataall.example.com",
+                config_path=str(tmp_path / "config.yaml"),
+            )

tests/functional/test_datall_sdk_client.py

@@ -5,21 +5,24 @@
 
 Dataall's SDK requires user profile information to be stored either in a local file or in AWS Secrets Manager. The user information required includes:
 
-- auth_type: Either `CognitoAuth` or `CustomAuth`
+- auth_type: `CognitoAuth`, `CustomAuth` or `OidcBrowserAuth` (browser login, no password)
 - client_id: The App Client ID
 - api_endpoint_url: The URL data.all API Gateway Endpoint 
-- redirect_uri: The data.all domain URL
-- idp_domain_url: The Identity Providers URL
+- redirect_uri: The data.all domain URL (for `OidcBrowserAuth`: the loopback URI registered for the client, default `http://localhost:8765/callback`)
+- idp_domain_url: The Identity Providers URL (for `OidcBrowserAuth`: the OIDC issuer URL)
 - client_secret (optional): The client secret used for the data.all App Client
 - auth_server (optional, used for CustomAuth): The Custom Authorization Server used if applicable
 - session_token_endpoint (optional, required for CustomAuth): The Identity Provider API endpoint to retrieve session tokens
+- scopes (optional, OidcBrowserAuth): OIDC scopes, default `openid offline_access`
+- fallback_redirect_uri (optional, OidcBrowserAuth): second loopback URI tried when the first port is busy
+- frontend_url (optional): the data.all UI URL, sent as `Origin` and `Referer` headers; required where the API only accepts calls carrying the UI origin
 - profile:  The Profile Name
 
 Data.all's SDK uses the profile information to fetch and save tokens from the data.all application. 
 
 By default the user information is provided at `~/.dataall/config.yaml` and the token information is saved at `~/.dataall/credentials.yaml`
 
-If a valid token or refresh token exists for the given user, that will be used to fetch a new token and authenticate the profile. Otherwise, the user will be prompted for username and password when running an API request and the fetched tokens will be saved.
+If a valid token or refresh token exists for the given user, that will be used to fetch a new token and authenticate the profile. Otherwise, the user will be prompted for username and password when running an API request and the fetched tokens will be saved. With `OidcBrowserAuth` the SDK opens the identity provider's login page in the browser instead (or prints a device code on hosts without a browser).
 
 
 ### Configuring your first data.all User profile
@@ -49,6 +52,20 @@ TestCustomProfile:
   session_token_endpoint: testtokenendpoint
 ```
 
+
+### Connecting with just the front page URL
+
+You do not have to write a profile by hand. Point the client at the data.all front page and the SDK reads the authentication type, identity provider, client id and API endpoint from the deployed application:
+
+```py3
+import dataall_sdk as dataall
+
+client = dataall.client(dataall_url="https://DATAALL_DOMAIN_URL")
+client.list_organizations()
+```
+
+The discovered profile is saved in `~/.dataall/config.yaml` under the page's host name (pass `profile="..."` to choose the name), so the next call reuses it without contacting the front page, and the tokens are kept in `credentials.yaml` as for any other profile. If a profile with that name already exists it is used as is. For OIDC deployments the first API call opens the browser for the login; the identity provider app must allow the loopback redirect URIs (`http://localhost:8765/callback` and `http://localhost:8766/callback`). Values that cannot be read from the page raise `MissingParametersException` naming them.
+
 ### Specifying your user profile
 
 Once you have configured your user profile appropriately, you can begin running data.all API requests via the SDK using your configured profile(s) such as: