/metakernel

Jupyter/IPython Kernel Tools

Primary LanguagePythonOtherNOASSERTION

A Jupyter/IPython kernel template which includes core magic functions (including help, command and file path completion, parallel and distributed processing, downloads, and much more).

https://badge.fury.io/py/metakernel.png/ https://coveralls.io/repos/Calysto/metakernel/badge.png?branch=master

See IPython's docs on wrapper kernels.

Additional magics can be installed within the new kernel package under a magics subpackage.

Features

  • Basic set of line and cell magics for all kernels.
    • Python magic for accessing python interpreter.
    • Run kernels in parallel.
    • Shell magics.
    • Classroom management magics.
  • Tab completion for magics and file paths.
  • Help for magics using ? or Shift+Tab.
  • Plot magic for setting default plot behavior.

Kernels based on Metakernel

... and many others.

Installation

You can install Metakernel through pip:

pip install metakernel --upgrade

Use MetaKernel Magics in IPython

Although MetaKernel is a system for building new kernels, you can use a subset of the magics in the IPython kernel.

from metakernel import register_ipython_magics
register_ipython_magics()

Put the following in your (or a system-wide) ipython_config.py file:

# /etc/ipython/ipython_config.py
c = get_config()
startup = [
   'from metakernel import register_ipython_magics',
   'register_ipython_magics()',
]
c.InteractiveShellApp.exec_lines = startup

Documentation

Example notebooks can be viewed here.

Documentation is available online. Magics have interactive help (and online).

For version information, see the Revision History.