Jupyter protocol implementation and client libraries
Project description
Jupyter Client
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jupyter_client-6.1.5-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9f0092a0951d878e7521924899e1fba6f689c7a99d43735a4c0bc05c6f311452 |
|
| MD5 | 9269a69f37ba7f9a744b1cbc3812f1c5 |
|
| BLAKE2b-256 | 934b26eabcf24b3e7cfdf063858609af45eecea245cf64d82e2fc88d2ef57857 |
