Skip to main content

vantage_sdk.jupyterhub_sdk

JupyterHub SDK for notebook server management.

Classes​

JupyterHubSDK()​

SDK for JupyterHub notebook server operations.

Methods​

  • create_notebook_server(self, ctx: typer.models.Context, cluster_name: str, username: str, server_name: str | None = None, server_options: Dict[str, Any] | None = None) -> Dict[str, Any]: Create a notebook server on a cluster.
  • get_cluster_jupyterhub_client(self, ctx: typer.models.Context, cluster_name: str) -> vantage_sdk.jupyterhub_client.JupyterHubClient: Get a JupyterHub client for a specific cluster.
  • get_notebook_server(self, ctx: typer.models.Context, cluster_name: str, username: str, server_name: str | None = None) -> Dict[str, Any] | None: Get information about a notebook server.
  • list_cluster_users(self, ctx: typer.models.Context, cluster_name: str) -> list[typing.Dict[str, typing.Any]]: List all users on a cluster's JupyterHub.
  • stop_notebook_server(self, ctx: typer.models.Context, cluster_name: str, username: str, server_name: str | None = None) -> bool: Stop a notebook server.