Skip to main content

vantage_sdk.jupyterhub_client

JupyterHub REST API Client for notebook server management.

Classes​

JupyterHubClient(hub_url: str, api_token: str)​

Client for interacting with JupyterHub REST API.

Methods​

  • close(self): Close the HTTP client.
  • create_user_server(self, username: str, server_name: str | None = None, options: Dict[str, Any] | None = None) -> Dict[str, Any]: Create a new notebook server for a user.
  • get_user_server(self, username: str, server_name: str | None = None) -> Dict[str, Any] | None: Get information about a user's notebook server.
  • list_users(self) -> list[typing.Dict[str, typing.Any]]: List all users in JupyterHub.
  • stop_user_server(self, username: str, server_name: str | None = None) -> bool: Stop a user's notebook server.