Package: jupyter-client
Jupyter Clientjupyter_clientcontains the reference implementation of theJupyter protocol.
It also provides client and kernel management APIs for working with kernels.It also provides thejupyter kernelspecentrypoint
for installing kernelspecs for use with Jupyter frontends.Development SetupTheJupyter Contributor Guidesprovide extensive information on contributing code or documentation to Jupyter projects. The limited instructions below for setting up a development environment are for your convenience.CodingYou'll need Python andpipon the search path. Clone the Jupyter Client git repository to your computer, for example in/my/project/jupyter_clientcd/my/projects/
gitclonegit@github.com:jupyter/jupyter_client.gitNow create aneditable installand download the dependencies of code and test suite by executing:cd/my/projects/jupyter_client/
pipinstall-e".[test]"pytestThe last command runs the test suite to verify the setup. During development, you can pass filenames topytest, and it will execute only those tests.DocumentationThe 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 themakecommand.
For a minimal Sphinx installation to process the Jupyter Client docs, execute:pipinstall".[doc]"The following commands build the documentation in HTML format and check for broken links:cd/my/projects/jupyter_client/docs/
makehtmllinkcheckPoint your browser to the following URL to access the generated documentation:file:///my/projects/jupyter_client/docs/_build/html/index.htmlContributingjupyter-clienthas 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-commitrunwhich should run any autoformatting on your code
and 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-commit
hook withpre-commit install, you can fix everything up usingpre-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 manualargument.About the Jupyter Development TeamThe 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/.Our Copyright PolicyJupyter uses a shared copyright model. Each contributor maintains copyright
over their contributions to Jupyter. But, it is important to note that these
contributions are typically only changes to the repositories. Thus, the Jupyter
source code, in its entirety is not the copyright of any single person or
institution. Instead, it is the collective copyright of the entire Jupyter
Development Team. If individual contributors want to maintain a record of what
changes/contributions they have specific copyright on, they should indicate
their copyright in the commit message of the change, when they commit the
change to one of the Jupyter repositories.With this in mind, the following banner should be used in any source code file
to indicate the copyright and license terms:# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.