MariaDB Jupyter Kernel Installation

The mariadb_kernel project uses the MariaDB command-line client under the hood as a child process, thus having MariaDB installed on your system is a hard requirement in order to be able to use the kernel.

If you don’t have it already installed, you can download the binaries from here. You also need JupyterLab or Notebook

If your MariaDB binaries are not in PATH, see the Configuring section to see how you can point the kernel to the right binaries path.

Quick Installation Steps

Follow these steps if you already have a clean Python environment and JupyterLab installed on your computer.

1. Install the kernel

python3 -m pip install mariadb_kernel

1. Install the kernelspec so that the kernel becomes visible to JupyterLab

python3 -m mariadb_kernel.install

Complete Installation Steps

This guide helps you set up a fresh Miniconda environment where you can install the kernel and the Jupyter applications without interfering with your normal environment.

1. Download and install miniconda

# After you downloaded the script run:
sh ./Miniconda3-latest-Linux-x86_64.sh

1. Create a new environment

conda create -n maria_env python=3.7

1. Activate the new env

# You should see the terminal prompt prefixed with (maria_env)
conda activate maria_env

1. Install JupyterLab

conda install -c conda-forge jupyterlab

1. Install the kernel

python3 -m pip install mariadb_kernel

1. Install the kernelspec so that the kernel becomes visible to JupyterLab

python3 -m mariadb_kernel.install

Platform Coverage

Our plan is to make mariadb_kernel as platform independent as Jupyter is. That means, fully functional on at least Linux, macOS and Windows.

Unfortunately at the moment, we can only guarantee it should work fine on POSIX-compliant systems, i.e. most Linux distributions and macOS as long as the prerequisites of the project are present on your system. This limitation is inherited from particular Python APIs that use POSIX-specific system calls and also from our dependency package Pexpect which has certain limitations on Windows systems.

Please create an issue here or vote (just write a quick comment saying that issue affects you as well) for an existing one if you’re on a particular platform that mariadb_kernel doesn’t currently work on. This will help us understand how we should focus our development efforts.