Package: nbserv-client
Jupyter NB Server Python ClientAn SDK and API-wrapper for the jupyter notebook REST API.API version: 5Package version: 1.0.0Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visithttps://jupyter.orgRequirements.Python 3.7+Installation & Usagepip installIf the python package is hosted on a repository, you can install directly using:pipinstallgit+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to runpipwith root permission:sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)Then import the package:importnbserv_clientSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importnbserv_clientTestsExecutepytestto run the tests.Getting StartedPlease follow theinstallation procedureand then run the following:importtimeimportnbserv_clientfromnbserv_client.restimportApiExceptionfrompprintimportpprint# 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 clientwithnbserv_client.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_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)exceptApiExceptionase:print("Exception when calling ApiSpecApi->api_spec_yaml_get:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttp://localhostClassMethodHTTP requestDescriptionApiSpecApiapi_spec_yaml_getGET/api/spec.yamlGet the current spec for the notebook server's APIs.ConfigApiapi_config_section_name_getGET/api/config/{section_name}Get a configuration section by nameConfigApiapi_config_section_name_patchPATCH/api/config/{section_name}Update a configuration section by nameContentsApiapi_contents_path_checkpoints_checkpoint_id_deleteDELETE/api/contents/{path}/checkpoints/{checkpoint_id}Delete a checkpointContentsApiapi_contents_path_checkpoints_checkpoint_id_postPOST/api/contents/{path}/checkpoints/{checkpoint_id}Restore a file to a particular checkpointed stateContentsApiapi_contents_path_checkpoints_getGET/api/contents/{path}/checkpointsGet a list of checkpoints for a fileContentsApiapi_contents_path_checkpoints_postPOST/api/contents/{path}/checkpointsCreate a new checkpoint for a fileContentsApiapi_contents_path_deleteDELETE/api/contents/{path}Delete a file in the given pathContentsApiapi_contents_path_getGET/api/contents/{path}Get contents of file or directoryContentsApiapi_contents_path_patchPATCH/api/contents/{path}Rename a file or directory without re-uploading contentContentsApiapi_contents_path_postPOST/api/contents/{path}Create a new file in the specified pathContentsApiapi_contents_path_putPUT/api/contents/{path}Save or upload file.DefaultApiapi_getGET/api/Get the Jupyter Server versionIdentityApiapi_me_getGET/api/meGet the identity of the currently authenticated user. If present, a `permissions` argument may be specified to check what actions the user currently is authorized to take.KernelsApiapi_kernels_getGET/api/kernelsList the JSON data for all kernels that are currently runningKernelsApiapi_kernels_kernel_id_deleteDELETE/api/kernels/{kernel_id}Kill a kernel and delete the kernel idKernelsApiapi_kernels_kernel_id_getGET/api/kernels/{kernel_id}Get kernel informationKernelsApiapi_kernels_kernel_id_interrupt_postPOST/api/kernels/{kernel_id}/interruptInterrupt a kernelKernelsApiapi_kernels_kernel_id_restart_postPOST/api/kernels/{kernel_id}/restartRestart a kernelKernelsApiapi_kernels_postPOST/api/kernelsStart a kernel and return the uuidKernelspecsApiapi_kernelspecs_getGET/api/kernelspecsGet kernel specsSessionsApiapi_sessions_getGET/api/sessionsList available sessionsSessionsApiapi_sessions_postPOST/api/sessionsCreate a new session, or return an existing session if a session of the same name already existsSessionsApiapi_sessions_session_deleteDELETE/api/sessions/{session}Delete a sessionSessionsApiapi_sessions_session_getGET/api/sessions/{session}Get sessionSessionsApiapi_sessions_session_patchPATCH/api/sessions/{session}This can be used to rename the session.StatusApiapi_status_getGET/api/statusGet the current status/activity of the server.TerminalsApiapi_terminals_getGET/api/terminalsGet available terminalsTerminalsApiapi_terminals_postPOST/api/terminalsCreate a new terminalTerminalsApiapi_terminals_terminal_id_deleteDELETE/api/terminals/{terminal_id}Delete a terminal session corresponding to an id.TerminalsApiapi_terminals_terminal_id_getGET/api/terminals/{terminal_id}Get a terminal session corresponding to an id.Documentation For ModelsAPIStatusApiContentsPathGet400ResponseApiContentsPathPostRequestApiContentsPathPutRequestApiGet200ResponseApiKernelsPostRequestApiKernelspecsGet200ResponseApiMeGet200ResponseApiSessionsPost501ResponseCheckpointsContentsIdentityKernelKernelSpecKernelSpecFileKernelSpecFileHelpLinksInnerKernelSpecResourcesSessionTerminalDocumentation For AuthorizationEndpoints do not require authorization.Author