Jupyter NB Server Python Client

An SDK and API-wrapper for the jupyter notebook REST API.

• API version: 5
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://jupyter.org

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import nbserv_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import nbserv_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import nbserv_client
from nbserv_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = nbserv_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with nbserv_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nbserv_client.ApiSpecApi(api_client)

    try:
        # Get the current spec for the notebook server's APIs.
        api_response = api_instance.api_spec_yaml_get()
        print("The response of ApiSpecApi->api_spec_yaml_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApiSpecApi->api_spec_yaml_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• APIStatus
• ApiContentsPathGet400Response
• ApiContentsPathPostRequest
• ApiContentsPathPutRequest
• ApiGet200Response
• ApiKernelsPostRequest
• ApiKernelspecsGet200Response
• ApiMeGet200Response
• ApiSessionsPost501Response
• Checkpoints
• Contents
• Identity
• Kernel
• KernelSpec
• KernelSpecFile
• KernelSpecFileHelpLinksInner
• KernelSpecResources
• Session
• Terminal

Documentation For Authorization

Endpoints do not require authorization.

Author