ElixirNote Lab Server

TOC

Introduction

ElixirNote Lab Server sits between ElixirNote and Elixir Server, and provides a set of REST API handles and utilities that are used by ElixirNote. It is a separate project in order to accommodate creating ElixirNote-like applications from a more limited scope.

Installation

pip install elixirlab-server

Application

A Lab Server Application that runs out-of-the-box: LabServerApp.

Detail methods in LabServerApp:

  • allow_extensions_uris: A list of comma-separated URIs to get the allowed extensions list.

  • answer_yes: Answer yes to any prompts.

  • app_settings_dir: The application settings directory.

  • app_url: The URL path for the application.

  • blocked_extensions_uris: A list of comma-separated URIs to get the blocked extensions list.

  • cache_files: Whether to cache files on the server. This should be True except in dev mode.

  • config_file: Full path of a config file.

  • config_file_name: Specify a config file to load.

  • extra_labextensions_path: Extra paths to look for federated ElixirNote extensions.

  • generate_config: Generate the default config file.

  • handlers: Handlers appended to the server.

  • jinja2_options: Options to pass to the jinja2 environment for this.

  • labextensions_path: The standard paths to look in for federated ElixirNote extensions.

  • labextensions_url: The URL for federated ElixirNote extensions.

  • listings_refresh_seconds: The interval delay in seconds to refresh the lists.

  • log_datefmt: The data format used by logging format for % (asctime)s.

  • log_format: The Logging format template.

  • log_level: Set the log level by value or name.

  • logging_config: Config additional log handlers.

  • notebook_starts_kernel: Whether a notebook should start a kernel automatically.

  • open_browser: Whether to open a browser after starting.

  • schemas_dir: The optional location of the settings schemas directory. If given, a handler will be added for settings.

  • settings: Settings that will passed to the server.

  • settings_url: The URL path of the settings handler.

  • show_config: Instead of starting the Application, dump configuration to stdout.

  • show_config_json: Instead of starting the Application, dump configuration to stdout (as JSON).

  • static_dir: The optional location of local static files. If given, a static file handler will be added.

  • static_paths: Paths to search serving static files.

  • template_path: Paths to search for serving jinja templates.

  • theme_dir: The optional location of the themes directory. If given, a handler will be added for themes.

  • tree_url: The URL path of the tree handler.

  • user_settings_dir: The optional location of the user settings directory.

  • workspace_dir: The optional location of the saved workspaces directory. If given, a handler will be added for workspaces.

Config

Refer to here.

Handlers

Refer to here.

Process

Refer to here.

REST APIs

Refer to here.

OpenAPI Specs

Refer to here.

Last updated