Notebook

Warning

The functions are not fully tested yet. Use with caution. Please report any issues to the GitHub repository.

notebook_create

notebook_create(workspace_id: str, display_name: str, notebook_path: str, description: str = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Create a notebook.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to create the notebook in.	required
display_name	str	The display name of the notebook.	required
notebook_path	str	The path to the notebook to load content from.	required
description	str | None	The description of the notebook.	None
await_lro	bool | None	Whether to await the long running operation.	None
timeout	int	Timeout for the long running operation (seconds). Defaults to 5 minutes.	60 * 5
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

notebook_get

notebook_get(workspace_id: str, notebook_id: str, preview: bool = True) -> requests.Response

Get a notebook.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to get the notebook from.	required
notebook_id	str	The id of the notebook to get.	required
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

notebook_list

notebook_list(workspace_id: str, continuation_token: str = None, preview: bool = True) -> requests.Response

List notebooks for a workspace.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to list notebooks for.	required
continuation_token	str | None	A token for retrieving the next page of results.	None
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

notebook_update

notebook_update(workspace_id: str, notebook_id: str, display_name: str = None, description: str = None, preview: bool = True) -> requests.Response

Update a notebook.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to update.	required
notebook_id	str	The id of the notebook to update.	required
display_name	str | None	The display name of the notebook.	None
description	str | None	The description of the notebook.	None
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

notebook_delete

notebook_delete(workspace_id: str, notebook_id: str, preview: bool = True) -> requests.Response

Delete a notebook.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to delete.	required
notebook_id	str	The id of the notebook to delete.	required
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

notebook_get_definition

notebook_get_definition(workspace_id: str, notebook_id: str, format: str = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Get the definition of a notebook.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to get the notebook definition from.	required
notebook_id	str	The id of the notebook to get the definition from.	required
format	str | None	The format of the Notebook definition. Supported format is "ipynb".	None
await_lro	bool | None	Whether to await the long running operation.	None
timeout	int	Timeout for the long running operation (seconds). Defaults to 5 minutes.	60 * 5
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

notebook_update_definition

notebook_update_definition(workspace_id: str, notebook_id: str, notebook_path: str, update_metadata: bool = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Update the definition of a notebook.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to update.	required
notebook_id	str	The id of the notebook to update.	required
notebook_path	str	The path to the notebook to load content from.	required
update_metadata	bool | None	When set to true, the item's metadata is updated using the metadata in the .platform file.	None
await_lro	bool | None	Whether to await the long running operation.	None
timeout	int	Timeout for the long running operation (seconds). Defaults to 5 minutes.	60 * 5
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.