Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nteract/kernel-relay
kernel-relay is a GraphQL service for interfacing with one or more Jupyter kernels
https://github.com/nteract/kernel-relay
graphql jupyter jupyter-notebook
Last synced: 2 months ago
JSON representation
kernel-relay is a GraphQL service for interfacing with one or more Jupyter kernels
- Host: GitHub
- URL: https://github.com/nteract/kernel-relay
- Owner: nteract
- Created: 2019-02-04T21:12:54.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T02:47:40.000Z (almost 2 years ago)
- Last Synced: 2024-09-28T23:43:28.122Z (3 months ago)
- Topics: graphql, jupyter, jupyter-notebook
- Language: TypeScript
- Homepage:
- Size: 1.14 MB
- Stars: 12
- Watchers: 13
- Forks: 6
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-jupyter-resources - GitHub - 83% open · ⏱️ 10.07.2019): (Jupyter内核)
README
# @nteract/kernel-relay
This package provides a GraphQL API for managing communication between a
Jupyter kernel and front-end clients. The package allows users to control and
monitor kernels.
Through GraphQL queries and mutations, the API enables the user to launch
kernels, subscribe to the status of a kernel, send Jupyter messages from a
client to a kernel, and more.
The architecture diagram below shows how the kernel-relay sits alongisde Jupyter kernels
and serves clients.
## Installation
```
$ yarn add @nteract/kernel-relay
```
```
$ npm install --save @nteract/kernel-relay
```
## Developer Installation
To get started developing on `kernel-relay`, you'll need to clone this repository.
```
$ git clone https://github.com/nteract/kernel-relay.git
```
Then, you'll need to install the dependencies within this repository.
```
$ yarn
OR
$ npm install
```
You can then run the GraphQL server with a playground UI.
```
$ yarn start
```
## Docker Setup
To run an instance of the kernel-relay within a Docker container, you can execute the following commands. Note that you will need to have Docker installed on your machine.
First, run the following in the cloned directory to build a Docker image.
```
$ docker build -t nteract/kernel-relay-dev:latest .
```
Then, run a Docker container based on this image.
```
$ docker run -p 4000:4000 -t nteract/kernel-relay-dev:latest
```
Next, navigate to http://localhost:4000 in your browser to interact with the instance of the kernel-relay running within your Docker container.
## Usage
The query example below showcases how to use the GraphQL API to get the status
of a kernel.
```
> query GetKernels {
listKernelSpecs {
name
}
}
{
"data": {
"listKernelSpecs": [
{
"name": "python3"
}
]
}
}
> mutation StartJupyterKernel {
startKernel(name: "python3") {
id
status
}
}
{
"data": {
"startKernel": [
{
"name": "python3",
"id": "a-uuid",
"status": "started"
}
]
}
}
```
## Documentation
We're working on adding more documentation for this component. Stay tuned by
watching this repository!
## Support
If you experience an issue while using this package or have a feature request,
please file an issue on the [issue board](https://github.com/nteract/nteract/issues/new/choose)
and, if possible, add the `pkg:kernel-relay` label.
## License
[BSD-3-Clause](https://choosealicense.com/licenses/bsd-3-clause/)