Skip to main content

Jupyter protocol implementation and client libraries

Project description

Jupyter Client

Code Health

jupyter_client contains the reference implementation of the Jupyter protocol. It also provides client and kernel management APIs for working with kernels.

It also provides the jupyter kernelspec entrypoint for installing kernelspecs for use with Jupyter frontends.

Development Setup

The Jupyter Contributor Guides provide extensive information on contributing code or documentation to Jupyter projects. The limited instructions below for setting up a development environment are for your convenience.

Coding

You'll need Python and pip on the search path. Clone the Jupyter Client git repository to your computer, for example in /my/project/jupyter_client. Now create an editable install and download the dependencies of code and test suite by executing:

cd /my/projects/jupyter_client/
pip install -e .[test]
py.test

The last command runs the test suite to verify the setup. During development, you can pass filenames to py.test, and it will execute only those tests.

Documentation

The documentation of Jupyter Client is generated from the files in docs/ using Sphinx. Instructions for setting up Sphinx with a selection of optional modules are in the Documentation Guide. You'll also need the make command. For a minimal Sphinx installation to process the Jupyter Client docs, execute:

pip install ipykernel sphinx sphinx_rtd_theme

The following commands build the documentation in HTML format and check for broken links:

cd /my/projects/jupyter_client/docs/
make html linkcheck

Point your browser to the following URL to access the generated documentation:

file:///my/projects/jupyter_client/docs/_build/html/index.html

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for jupyter-client, version 5.3.4
Filename, size File type Python version Upload date Hashes
Filename, size jupyter_client-5.3.4-py2.py3-none-any.whl (92.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size jupyter_client-5.3.4.tar.gz (275.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page