| Name | jupyter-kernel-gateway JSON |
| Version |
3.0.1
JSON |
| download |
| home_page | |
| Summary | A web server for spawning and communicating with Jupyter kernels |
| upload_time | 2024-03-12 17:51:34 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | # Licensing terms This project is licensed under the terms of the Modified BSD License (also known as New or Revised or 3-Clause BSD), as follows: - Copyright (c) 2001-2015, IPython Development Team - Copyright (c) 2015-, Jupyter Development Team All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the Jupyter Development Team nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ## About the Jupyter Development Team The Jupyter Development Team is the set of all contributors to the Jupyter project. This includes all of the Jupyter Subprojects, which are the different repositories under the [jupyter](https://github.com/jupyter/) GitHub organization. The core team that coordinates development on GitHub can be found here: https://github.com/jupyter/. ## Our copyright policy Jupyter 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. ``` |
| keywords |
cloud
interactive
interpreter
kernel
web
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Jupyter Kernel Gateway
[](https://groups.google.com/forum/#!forum/jupyter)
[](https://badge.fury.io/py/jupyter_kernel_gateway)
[](https://github.com/jupyter/kernel_gateway/actions?query=workflow%3ATests)
[](https://jupyter-kernel-gateway.readthedocs.io/en/latest/?badge=latest)
## Overview
Jupyter Kernel Gateway is a web server that provides headless access to
Jupyter kernels. Your application communicates with the kernels remotely,
through REST calls and Websockets rather than ZeroMQ messages.
There are no provisions for editing notebooks through the Kernel Gateway.
The following operation modes, called personalities, are supported
out of the box:
- Send code snippets for execution using the
[Jupyter kernel protocol](https://jupyter-client.readthedocs.io/en/latest/messaging.html)
over Websockets. Start and stop kernels through REST calls.
This HTTP API is compatible with the respective API sections
of the Jupyter Notebook server.
- Serve HTTP requests from annotated notebook cells. The code snippets
are cells of a static notebook configured in the Kernel Gateway.
Annotations define which HTTP verbs and resources it supports.
Incoming requests are served by executing one of the cells in a kernel.
Jupyter Kernel Gateway uses the same code as Jupyter Notebook
to launch kernels in its local process/filesystem space.
It can be containerized and scaled out using common technologies like [tmpnb](https://github.com/jupyter/tmpnb), [Cloud Foundry](https://github.com/cloudfoundry), and [Kubernetes](http://kubernetes.io/).
### Example Uses of Kernel Gateway
- Attach a local Jupyter Notebook server to a compute cluster in the cloud running near big data (e.g., interactive gateway to Spark)
- Enable a new breed of non-notebook web clients to provision and use kernels (e.g., web dashboards using [jupyter-js-services](https://github.com/jupyter/jupyter-js-services))
- Create microservices from notebooks using the Kernel Gateway [`notebook-http` mode](https://jupyter-kernel-gateway.readthedocs.io/en/latest/http-mode.html)
### Features
See the [Features page](https://jupyter-kernel-gateway.readthedocs.io/en/latest/features.html) in the
documentation for a list of the Jupyter Kernel Gateway features.
## Installation
Detailed installation instructions are located in the
[Getting Started page](https://jupyter-kernel-gateway.readthedocs.io/en/latest/getting-started.html)
of the project docs. Here's a quick start using `pip`:
```bash
# install from pypi
pip install jupyter_kernel_gateway
# show all config options
jupyter kernelgateway --help-all
# run it with default options
jupyter kernelgateway
```
## Contributing
The [Development page](https://jupyter-kernel-gateway.readthedocs.io/en/latest/devinstall.html) includes information about setting up a development environment and typical developer tasks.
Raw data
{
"_id": null,
"home_page": "",
"name": "jupyter-kernel-gateway",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Cloud,Interactive,Interpreter,Kernel,Web",
"author": "",
"author_email": "Jupyter Development Team <jupyter@googlegroups.com>",
"download_url": "https://files.pythonhosted.org/packages/0f/f4/6672cae9f6f36be7566496dbe2f78a8e39d4db73b36c2911c83320dd7027/jupyter_kernel_gateway-3.0.1.tar.gz",
"platform": null,
"description": "# Jupyter Kernel Gateway\n\n[](https://groups.google.com/forum/#!forum/jupyter)\n[](https://badge.fury.io/py/jupyter_kernel_gateway)\n[](https://github.com/jupyter/kernel_gateway/actions?query=workflow%3ATests)\n[](https://jupyter-kernel-gateway.readthedocs.io/en/latest/?badge=latest)\n\n## Overview\n\nJupyter Kernel Gateway is a web server that provides headless access to\nJupyter kernels. Your application communicates with the kernels remotely,\nthrough REST calls and Websockets rather than ZeroMQ messages.\nThere are no provisions for editing notebooks through the Kernel Gateway.\nThe following operation modes, called personalities, are supported\nout of the box:\n\n- Send code snippets for execution using the\n [Jupyter kernel protocol](https://jupyter-client.readthedocs.io/en/latest/messaging.html)\n over Websockets. Start and stop kernels through REST calls.\n This HTTP API is compatible with the respective API sections\n of the Jupyter Notebook server.\n\n- Serve HTTP requests from annotated notebook cells. The code snippets\n are cells of a static notebook configured in the Kernel Gateway.\n Annotations define which HTTP verbs and resources it supports.\n Incoming requests are served by executing one of the cells in a kernel.\n\nJupyter Kernel Gateway uses the same code as Jupyter Notebook\nto launch kernels in its local process/filesystem space.\nIt can be containerized and scaled out using common technologies like [tmpnb](https://github.com/jupyter/tmpnb), [Cloud Foundry](https://github.com/cloudfoundry), and [Kubernetes](http://kubernetes.io/).\n\n### Example Uses of Kernel Gateway\n\n- Attach a local Jupyter Notebook server to a compute cluster in the cloud running near big data (e.g., interactive gateway to Spark)\n- Enable a new breed of non-notebook web clients to provision and use kernels (e.g., web dashboards using [jupyter-js-services](https://github.com/jupyter/jupyter-js-services))\n- Create microservices from notebooks using the Kernel Gateway [`notebook-http` mode](https://jupyter-kernel-gateway.readthedocs.io/en/latest/http-mode.html)\n\n### Features\n\nSee the [Features page](https://jupyter-kernel-gateway.readthedocs.io/en/latest/features.html) in the\ndocumentation for a list of the Jupyter Kernel Gateway features.\n\n## Installation\n\nDetailed installation instructions are located in the\n[Getting Started page](https://jupyter-kernel-gateway.readthedocs.io/en/latest/getting-started.html)\nof the project docs. Here's a quick start using `pip`:\n\n```bash\n# install from pypi\npip install jupyter_kernel_gateway\n\n# show all config options\njupyter kernelgateway --help-all\n\n# run it with default options\njupyter kernelgateway\n```\n\n## Contributing\n\nThe [Development page](https://jupyter-kernel-gateway.readthedocs.io/en/latest/devinstall.html) includes information about setting up a development environment and typical developer tasks.\n",
"bugtrack_url": null,
"license": "# Licensing terms This project is licensed under the terms of the Modified BSD License (also known as New or Revised or 3-Clause BSD), as follows: - Copyright (c) 2001-2015, IPython Development Team - Copyright (c) 2015-, Jupyter Development Team All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the Jupyter Development Team nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ## About the Jupyter Development Team The Jupyter Development Team is the set of all contributors to the Jupyter project. This includes all of the Jupyter Subprojects, which are the different repositories under the [jupyter](https://github.com/jupyter/) GitHub organization. The core team that coordinates development on GitHub can be found here: https://github.com/jupyter/. ## Our copyright policy Jupyter 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. ```",
"summary": "A web server for spawning and communicating with Jupyter kernels",
"version": "3.0.1",
"project_urls": {
"Homepage": "http://github.com/jupyter-incubator/kernel_gateway"
},
"split_keywords": [
"cloud",
"interactive",
"interpreter",
"kernel",
"web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3da2e0a4616fde099b71ef996e5ae117451bc80b15f89807d1f3db9298644209",
"md5": "498e1573ac5652bd9025d4772e0e41fe",
"sha256": "9f74a2f4ff9f03737bcab79f44ae0f6473ee32deb30fce00b8f05adcdd023f03"
},
"downloads": -1,
"filename": "jupyter_kernel_gateway-3.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "498e1573ac5652bd9025d4772e0e41fe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 53007,
"upload_time": "2024-03-12T17:51:31",
"upload_time_iso_8601": "2024-03-12T17:51:31.918276Z",
"url": "https://files.pythonhosted.org/packages/3d/a2/e0a4616fde099b71ef996e5ae117451bc80b15f89807d1f3db9298644209/jupyter_kernel_gateway-3.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0ff46672cae9f6f36be7566496dbe2f78a8e39d4db73b36c2911c83320dd7027",
"md5": "a70befcd0425603d3756ed98d310af05",
"sha256": "900690c4c0e796867355468d685f7fa1cf3c7775d08e871c157f77d65fbd6d7f"
},
"downloads": -1,
"filename": "jupyter_kernel_gateway-3.0.1.tar.gz",
"has_sig": false,
"md5_digest": "a70befcd0425603d3756ed98d310af05",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 54607,
"upload_time": "2024-03-12T17:51:34",
"upload_time_iso_8601": "2024-03-12T17:51:34.642030Z",
"url": "https://files.pythonhosted.org/packages/0f/f4/6672cae9f6f36be7566496dbe2f78a8e39d4db73b36c2911c83320dd7027/jupyter_kernel_gateway-3.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-12 17:51:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jupyter-incubator",
"github_project": "kernel_gateway",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyter-kernel-gateway"
}
