Dev/sso login ux

CHANGELOG.md

@@ -6,6 +6,11 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and all PyGraphistry-specific breaking changes are explictly noted here.
 
 ## [Development]
+### Added
+* Added new wrapper function for register to Databricks via SSO, to simplify code to display on dashboard
+
+### Fixes
+* Fix refresh function does not reset some variable in memory that cause weird behavior
 
 ## [0.35.3 - 2024-12-24]
 
@@ -59,6 +64,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 * `plot(render=)` now `Union[bool, RenderMode]`, not just `bool` 
 
+* Documentation changed for databricks related docs
+
 ## [0.34.17 - 2024-10-20]
 
 ### Added

demos/demos_databases_apis/databricks_pyspark/graphistry-notebook-dashboard.ipynb

@@ -152,6 +152,10 @@
     "                    protocol='https',\n",
     "                    server='hub.graphistry.com')\n",
     "\n",
+    "# Alternatively, use SSO: \n",
+    "# graphistry.register_databricks_sso(api=3, server='hub.graphistry.com', org_name='my-org')\n",
+    "# For more options, see https://github.com/graphistry/pygraphistry#configure\n",
+    "\n",
     "# Alternatively, use username and password: \n",
     "# graphistry.register(api=3, username='...', password='...', protocol='https', server='hub.graphistry.com')\n",
     "# For more options, see https://github.com/graphistry/pygraphistry#configure"

docs/source/server/register.rst

@@ -219,6 +219,20 @@ Register with Custom Browser Routing
         client_protocol_hostname="https://my_ui_server.com"
     )
 
+Register with SSO using helper function(only for databricks, organization with Specific IdP)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: python
+
+    import graphistry
+
+    graphistry.databricks_register_sso(
+        api=3,
+        org_name="my_org_name",
+        idp_name="my_idp_name",
+        sso_opt_into_type="browser"
+    )
+
 ---
 
 Best Practices

graphistry/PlotterBase.py

@@ -1553,7 +1553,20 @@ def plot(
             info = PyGraphistry._etl1(dataset)
         elif api_version == 3:
             logger.debug("3. @PloatterBase plot: PyGraphistry.org_name(): {}".format(PyGraphistry.org_name()))
-            PyGraphistry.refresh()
+
+            if not PyGraphistry.api_token() and PyGraphistry.sso_state():  # if it is sso login
+                if in_ipython() or in_databricks() or PyGraphistry._config["sso_opt_into_type"] == 'display':
+                    PyGraphistry.sso_wait_for_token_text_display()
+                    if not PyGraphistry.sso_verify_token_display():
+                        from IPython.core.display import HTML
+                        msg_html = "<strong>Invalid token due to login timeout</strong>"
+                        return HTML(msg_html)
+                else:
+                    PyGraphistry.sso_repeat_get_token()
+
+
+            else:  # if not sso mode, just refresh to make sure token is valid
+                PyGraphistry.refresh()
             logger.debug("4. @PloatterBase plot: PyGraphistry.org_name(): {}".format(PyGraphistry.org_name()))
 
             dataset = self._plot_dispatch_arrow(g, n, name, description, self._style, memoize)

graphistry/__init__.py

@@ -46,7 +46,9 @@
     ArrowFileUploader,
     PyGraphistry,
     from_igraph,
-    from_cugraph
+    from_cugraph,
+    sso_wait_for_token_display,
+    register_databricks_sso,
 )
 
 from graphistry.compute import (