{"id":13606881,"url":"https://github.com/nteract/kernel-relay","last_synced_at":"2025-10-28T03:31:24.952Z","repository":{"id":4200872,"uuid":"169150709","full_name":"nteract/kernel-relay","owner":"nteract","description":"kernel-relay is a GraphQL service for interfacing with one or more Jupyter kernels","archived":false,"fork":false,"pushed_at":"2023-01-04T02:47:40.000Z","size":1191,"stargazers_count":12,"open_issues_count":28,"forks_count":6,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-02-01T10:51:09.987Z","etag":null,"topics":["graphql","jupyter","jupyter-notebook"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nteract.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-04T21:12:54.000Z","updated_at":"2023-02-10T03:04:53.000Z","dependencies_parsed_at":"2023-01-11T20:12:18.927Z","dependency_job_id":null,"html_url":"https://github.com/nteract/kernel-relay","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nteract%2Fkernel-relay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nteract%2Fkernel-relay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nteract%2Fkernel-relay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nteract%2Fkernel-relay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nteract","download_url":"https://codeload.github.com/nteract/kernel-relay/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238590593,"owners_count":19497351,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["graphql","jupyter","jupyter-notebook"],"created_at":"2024-08-01T19:01:13.427Z","updated_at":"2025-10-28T03:31:14.936Z","avatar_url":"https://github.com/nteract.png","language":"TypeScript","readme":"# @nteract/kernel-relay\n\nThis package provides a GraphQL API for managing communication between a\nJupyter kernel and front-end clients. The package allows users to control and\nmonitor kernels.\n\nThrough GraphQL queries and mutations, the API enables the user to launch\nkernels, subscribe to the status of a kernel, send Jupyter messages from a\nclient to a kernel, and more.\n\nThe architecture diagram below shows how the kernel-relay sits alongisde Jupyter kernels\nand serves clients.\n\n![nteract-kernel-relay](https://user-images.githubusercontent.com/1857993/54857237-6b0b2a80-4cbb-11e9-8ca9-68c4a25359a2.png)\n\n## Installation\n\n```\n$ yarn add @nteract/kernel-relay\n```\n\n```\n$ npm install --save @nteract/kernel-relay\n```\n\n## Developer Installation\n\nTo get started developing on `kernel-relay`, you'll need to clone this repository.\n\n```\n$ git clone https://github.com/nteract/kernel-relay.git\n```\n\nThen, you'll need to install the dependencies within this repository.\n\n```\n$ yarn\nOR\n$ npm install\n```\n\nYou can then run the GraphQL server with a playground UI.\n\n```\n$ yarn start\n```\n\n## Docker Setup\n\nTo 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.\n\nFirst, run the following in the cloned directory to build a Docker image.\n\n```\n$ docker build -t nteract/kernel-relay-dev:latest .\n```\n\nThen, run a Docker container based on this image.\n\n```\n$ docker run  -p 4000:4000 -t nteract/kernel-relay-dev:latest\n```\n\nNext, navigate to http://localhost:4000 in your browser to interact with the instance of the kernel-relay running within your Docker container.\n\n## Usage\n\nThe query example below showcases how to use the GraphQL API to get the status\nof a kernel.\n\n```\n\u003e query GetKernels {\n  listKernelSpecs {\n    name\n  }\n}\n\n{\n  \"data\": {\n    \"listKernelSpecs\": [\n      {\n        \"name\": \"python3\"\n      }\n    ]\n  }\n}\n\n\n\u003e mutation StartJupyterKernel {\n  startKernel(name: \"python3\") {\n    id\n    status\n  }\n}\n\n{\n  \"data\": {\n    \"startKernel\": [\n      {\n        \"name\": \"python3\",\n        \"id\": \"a-uuid\",\n        \"status\": \"started\"\n      }\n    ]\n  }\n}\n```\n\n## Documentation\n\nWe're working on adding more documentation for this component. Stay tuned by\nwatching this repository!\n\n## Support\n\nIf you experience an issue while using this package or have a feature request,\nplease file an issue on the [issue board](https://github.com/nteract/nteract/issues/new/choose)\nand, if possible, add the `pkg:kernel-relay` label.\n\n## License\n\n[BSD-3-Clause](https://choosealicense.com/licenses/bsd-3-clause/)\n","funding_links":[],"categories":["Jupyter内核"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnteract%2Fkernel-relay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnteract%2Fkernel-relay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnteract%2Fkernel-relay/lists"}