Repository files navigation

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

It also provides thejupyter kernelspec entrypointfor installing kernelspecs for use with Jupyter frontends.

TheJupyter 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.

You'll need Python andpip 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 aneditable installand 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 topytest, and it will execute only those tests.

The documentation of Jupyter Client is generated from the files indocs/ using Sphinx. Instructions for setting up Sphinx with a selection of optional modules are in theDocumentation Guide. You'll also need themake 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

jupyter-client has adopted automatic code formatting so you shouldn'tneed 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 codeand tell you about any errors it couldn't fix automatically.You may also installblack integrationinto your text editor to format code automatically.

If you have already committed files before setting up the pre-commithook withpre-commit install, you can fix everything up usingpre-commit run --all-files. You need to make the fixing commityourself after that.

Some of the hooks only run on CI by default, but you can invoke them byrunning with the--hook-stage manual argument.

The Jupyter Development Team is the set of all contributors to the Jupyter project.This includes all of the Jupyter subprojects.

The core team that coordinates development on GitHub can be found here:https://github.com/jupyter/.

Jupyter uses a shared copyright model. Each contributor maintains copyrightover their contributions to Jupyter. But, it is important to note that thesecontributions are typically only changes to the repositories. Thus, the Jupytersource code, in its entirety is not the copyright of any single person orinstitution. Instead, it is the collective copyright of the entire JupyterDevelopment Team. If individual contributors want to maintain a record of whatchanges/contributions they have specific copyright on, they should indicatetheir copyright in the commit message of the change, when they commit thechange to one of the Jupyter repositories.

With this in mind, the following banner should be used in any source code fileto indicate the copyright and license terms:

# Copyright (c) Jupyter Development Team.# Distributed under the terms of the Modified BSD License.