---
id: metakernel
version: "1.0.0"
license: BSD-3-Clause
license_treatment: permissive
maintenance: active
---

# metakernel — A Jupyter/IPython Kernel base class in Python

License: permissive · Maintenance: active · Downloads: 75.2K/mo

## What it is and what it does

MetaKernel is a framework for building custom Jupyter kernels by subclassing a base class that bundles common kernel functionality. It provides a set of line and cell magics (help, completion, shell commands, parallel execution), tab completion for magics and file paths, and configuration hooks for plot behavior and other traits. The package is designed so that kernel developers can focus on language-specific logic while inheriting standard interactive features.

You can use MetaKernel directly to add a subset of its magics to IPython, or use it as the foundation for a new kernel targeting a different language or runtime. The description lists many existing kernels built on MetaKernel, including matlab_kernel, octave_kernel, and others. It also supports parallel execution across multiple nodes when used with ipyparallel.

Use it for:

- Build a custom Jupyter kernel for a new language or runtime by subclassing MetaKernel.
- Add MetaKernel magics (help, completion, shell commands) to an existing IPython kernel.
- Run code in parallel across multiple Jupyter kernel instances using the %px and %%px magics.
- Configure plot behavior and other kernel traits via configuration files in the Jupyter config directory.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

MetaKernel is a base class for building custom Jupyter kernels in Python, providing core magic functions like help, completion, parallel processing, and shell integration.

Yes. MetaKernel is actively maintained, has low install friction, carries a permissive license, and no known vulnerabilities. Install it if you are building a custom Jupyter kernel or want to add MetaKernel magics to IPython. It is not necessary for standard Jupyter use.

## Install

pip install metakernel
uv add metakernel
poetry add metakernel

## Installing metakernel

Before you install: Low install friction with a pure-Python wheel distribution. Actively maintained with a recent release (143 days ago) and an active repository.

License in practice: BSD-3-Clause is a permissive license; you can use, modify, and distribute this package with minimal restrictions.

Quickstart:

pip install metakernel

from metakernel import register_ipython_magics
register_ipython_magics()

Requires Python 3.11 or later.

Verify before relying:

- Whether the package's parallel processing features require ipyparallel to be pre-installed or if it's optional.
- Whether custom kernel subclasses need additional configuration beyond the base class to function.

## Package facts

- License: BSD-3-Clause (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 75.2K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

jupyter kernel base class, custom jupyter kernel framework, jupyter magic functions, ipython kernel wrapper, parallel jupyter kernels, jupyter-kernel, interactive-computing

[View on SkillFed](https://skillfed.io/packages/metakernel) · [View on PyPI](https://pypi.org/project/metakernel/)