Mercury documentation

Mercury is an open-source (opens in a new tab) framework that helps you build web applications from your Jupyter Notebooks.

You can create with Mercury:

Mercury modes

Mercury offers set of widgets with simple re-execution of cells in the notebook.

Installation

Please install Mercury with the following command:

pip install mercury

# or

conda install -c conda-forge mercury

Start Mercury Server:

mercury run

Run Mercury demo:

mercury run demo

Import Mercury Widgets with the following code:

import mercury as mr

Run demo notebooks

Mercury comes with built-in demo notebooks. You can play with them by running:

mercury run demo

The above command will create demo notebooks and start development server. Please check the Mercury website at http://127.0.0.1:8000.

Quick Start

Let's build a very simple web app with Mercury. Please create a new Python notebook with the following three code cells.

import mercury as mr

name = mr.Text(label="What is your name?")

print(f"Hello {name.value}!")

Please run the following command in the same directory as notebook:

mercury run

You should see in the web browser at address http://127.0.0.1:8000 a Mercury website with your notebook.