Notebook Client

The bookstore.client.nb_client module

NotebookClient

class bookstore.client.nb_client.NotebookClient(nb_config)

Client used to interact with bookstore from within a running notebook UI

headers

Default headers to be shared across requests.

sessions

Current notebook sessions. Reissues request on each call.

setup_auth()

Sets up token access for authorizing requests to notebook server.

This sets the notebook token as self.token and the xsrf_token as self.xsrf_token.

setup_request_sessions()

Sets up a requests.Session object for sharing headers across API requests.

NotebookClientCollection

class bookstore.client.nb_client.NotebookClientCollection

Representation of a collection of notebook clients

classmethod current_server()

class method for current notebook server

CurrentNotebookClient

class bookstore.client.nb_client.CurrentNotebookClient

Represents the currently active notebook client

LiveNotebookRecord

class bookstore.client.nb_client.LiveNotebookRecord

Representation of live notebook server.

This is a record of an object returned by notebook.notebookapp.list_running_servers().

base_url

Alias for field number 0

hostname

Alias for field number 1

notebook_dir

Alias for field number 2

password

Alias for field number 3

pid

Alias for field number 4

port

Alias for field number 5

secure

Alias for field number 6

token

Alias for field number 7

url

Alias for field number 8

KernelInfo

class bookstore.client.nb_client.KernelInfo(*args, id, name, last_activity, execution_state, connections)

NotebookSession

class bookstore.client.nb_client.NotebookSession(*args, path, name, type, kernel, notebook, **kwargs)

Helper Function

bookstore.client.nb_client.extract_kernel_id(connection_file)

Get the kernel id string from a file