MariaDB Jupyter Kernel Installation

The mariadb_kernel project uses the 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 installed on your computer.

1. Install the kernel

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

Complete Installation Steps

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

1. Download and install

1. Create a new environment

1. Activate the new env

1. Install

1. Install the kernel

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

Platform Coverage

Our plan is to make as platform independent as 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 which has certain limitations on Windows systems.

Please create an issue 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 doesn’t currently work on. This will help us understand how we should focus our development efforts.