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
cd /my/projects/
git clone git@github.com:jupyter/jupyter_client.git
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]"
pytest
The last command runs the test suite to verify the setup. During development, you can pass filenames to pytest, 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 ".[doc]"
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
Contributing
jupyter-client has adopted automatic code formatting so you shouldn't
need to worry too much about your code style.
As long as your code is valid,
the pre-commit hook should take care of how it should look.
You can invoke the pre-commit hook by hand at any time with:
pre-commit run
which should run any autoformatting on your code and tell you about any errors it couldn't fix automatically. You may also install black integration into your text editor to format code automatically.
If you have already committed files before setting up the pre-commit
hook with pre-commit install, you can fix everything up using
pre-commit run --all-files. You need to make the fixing commit
yourself after that.
Some of the hooks only run on CI by default, but you can invoke them by
running with the --hook-stage manual argument.
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-7.4.9-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 214668aaea208195f4c13d28eb272ba79f945fc0cf3f11c7092c20b2ca1980e7 |
|
| MD5 | a1044eb70daee63d637859d89de6e5a9 |
|
| BLAKE2b-256 | fda7ef3b7c8b9d6730a21febdd0809084e4cea6d2a7e43892436adecdd0acbd4 |
