Merge pull request #444 from blink1073/metakernel

Update wrapper kernel docs

Author: rgbkrk

docs/wrapperkernels.rst

@@ -2,9 +2,9 @@ Making simple Python wrapper kernels
 ====================================
 
 You can re-use IPython's kernel machinery to easily make new kernels.
-This is useful for languages that have Python bindings, such as `Octave
-<http://www.gnu.org/software/octave/>`_ (via
-`Oct2Py <https://blink1073.github.io/oct2py/#>`_), or languages
+This is useful for languages that have Python bindings, such as `Hy
+<https://github.com/hylang/hy/>`_ (see
+`Calysto Hy <https://github.com/Calysto/calysto_hy/#>`_), or languages
 where the REPL can be controlled in a tty using `pexpect <https://pexpect.readthedocs.io/en/latest/>`_,
 such as bash.
 
@@ -13,6 +13,11 @@ such as bash.
    `bash_kernel <https://github.com/takluyver/bash_kernel>`_
      A simple kernel for bash, written using this machinery
 
+The `Metakernel <https://github.com/Calysto/metakernel/#>`_ library makes it easier to
+write a wrapper kernel that includes a base set of line and cell magics.  It also has a ``ProcessKernel`` subclass that makes it easy to write kernels that use ``pexpect``.
+See `Octave Kernel <https://github.com/Calysto/octave_kernel>`_ as an example.
+
+
 Required steps
 --------------
 
@@ -24,7 +29,7 @@ following methods and attributes:
    .. attribute:: implementation
                   implementation_version
                   banner
-    
+
      Information for :ref:`msging_kernel_info` replies. 'Implementation' refers
      to the kernel (e.g. IPython), rather than the language (e.g. Python).
      The 'banner' is displayed to the user in console
@@ -43,9 +48,9 @@ following methods and attributes:
      Other keys may be added to this later.
 
    .. method:: do_execute(code, silent, store_history=True, user_expressions=None, allow_stdin=False)
-   
+
      Execute user code.
-     
+
      :param str code: The code to be executed.
      :param bool silent: Whether to display output.
      :param bool store_history: Whether to record this code in history and
@@ -55,7 +60,7 @@ following methods and attributes:
          after the code has run. You can ignore this if you need to.
      :param bool allow_stdin: Whether the frontend can provide input on request
          (e.g. for Python's :func:`raw_input`).
-     
+
      Your method should return a dict containing the fields described in
      :ref:`execution_results`. To display output, it can send messages
      using :meth:`~ipykernel.kernelbase.Kernel.send_response`.
@@ -131,25 +136,25 @@ relevant section of the :doc:`messaging spec <messaging>`.
    .. method:: do_complete(code, cursor_pos)
 
      Code completion
-     
+
      :param str code: The code already present
      :param int cursor_pos: The position in the code where completion is requested
-     
+
      .. seealso::
-     
+
         :ref:`msging_completion` messages
 
    .. method:: do_inspect(code, cursor_pos, detail_level=0)
 
      Object introspection
-     
+
      :param str code: The code
      :param int cursor_pos: The position in the code where introspection is requested
      :param int detail_level: 0 or 1 for more or less detail. In IPython, 1 gets
          the source code.
-     
+
      .. seealso::
-     
+
         :ref:`msging_inspection` messages
 
    .. method:: do_history(hist_access_type, output, raw, session=None, start=None, stop=None, n=None, pattern=None, unique=False)
@@ -159,27 +164,27 @@ relevant section of the :doc:`messaging spec <messaging>`.
      for all the arguments shown with defaults here.
 
      .. seealso::
-     
+
         :ref:`msging_history` messages
 
    .. method:: do_is_complete(code)
-   
+
      Is code entered in a console-like interface complete and ready to execute,
      or should a continuation prompt be shown?
-     
+
      :param str code: The code entered so far - possibly multiple lines
-     
+
      .. seealso::
-     
+
         :ref:`msging_is_complete` messages
 
    .. method:: do_shutdown(restart)
 
      Shutdown the kernel. You only need to handle your own clean up - the kernel
      machinery will take care of cleaning up its own things before stopping.
-     
+
      :param bool restart: Whether the kernel will be started again afterwards
-     
+
      .. seealso::
-     
+
         :ref:`msging_shutdown` messages