======
nbexec
======

nbexec is a Jupyter extension for headless notebook execution. It adds a web API endpoint ``/api/executions`` to Jupyter notebook server which makes available to execute a notebook by requesting an HTTP request. It also allows you to define parameters in a notebook and give them at runtime (in each HTTP request).

nbexec publishes a documentation for a notebook in the URL path ``/execution_doc/<notebook_file>`` which shows the notebook description (written in markdown), parameters and the source code.

These features make possible to deploy your own API by just uploading a notebook.

**Contents:**

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   getting_started
   notebook_parameters
   execution_api
   execution_document
   related_work

.. seealso::

   `Jupyter Documentation <http://jupyter.readthedocs.io/en/latest/>`__
      The Jupyter documentation provides information about the Notebook code and other Jupyter sub-projects.
