# aiffel-jupyter-kernel

> This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

Latest version **0.0.17** (published 2022-07-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install aiffel-jupyter-kernel
pnpm add aiffel-jupyter-kernel
yarn add aiffel-jupyter-kernel
bun add aiffel-jupyter-kernel
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.17 |
| Published | 2022-07-06 |
| First published | 2022-02-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 67.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | modulabs |

## Links

- npm: https://www.npmjs.com/package/aiffel-jupyter-kernel
- Repository: https://github.com/aiffel-dev/aiffel-jupyter-kernel
- Homepage: https://github.com/aiffel-dev/aiffel-jupyter-kernel#readme
- Issues: https://github.com/aiffel-dev/aiffel-jupyter-kernel/issues
- npm.io page: https://npm.io/package/aiffel-jupyter-kernel

## Dependencies (8)

- [nanoevents](https://npm.io/package/nanoevents.md) ^6.0.2
- [monaco-editor](https://npm.io/package/monaco-editor.md) >= 0.25.0 < 1
- [@lumino/widgets](https://npm.io/package/@lumino/widgets.md) ^1.31.1
- [@jupyterlab/services](https://npm.io/package/@jupyterlab/services.md) ^6.2.9
- [@monaco-editor/react](https://npm.io/package/@monaco-editor/react.md) ^4.3.1
- [@jupyterlab/outputarea](https://npm.io/package/@jupyterlab/outputarea.md) ^3.2.9
- [@jupyterlab/rendermime](https://npm.io/package/@jupyterlab/rendermime.md) ^3.2.9
- [@jupyterlab/theme-light-extension](https://npm.io/package/@jupyterlab/theme-light-extension.md) ^3.2.9

## Recent versions

- 0.0.17 (latest) — 2022-07-06
- 0.0.16 — 2022-03-15
- 0.0.15 — 2022-03-10
- 0.0.14 — 2022-03-10
- 0.0.13 — 2022-03-10
- 0.0.12 — 2022-03-08
- 0.0.11 — 2022-03-07
- 0.0.10 — 2022-03-03
- 0.0.9 — 2022-03-03
- 0.0.8 — 2022-03-02
- 0.0.7 — 2022-02-28
- 0.0.6 — 2022-02-28
- 0.0.5 — 2022-02-18
- 0.0.4 — 2022-02-18
- 0.0.3 — 2022-02-18
- … 2 more at https://npm.io/package/aiffel-jupyter-kernel/versions

## README

# aiffel-jupyter-kernel

## Get Started

### Installation

```
$ yarn add aiffel-jupyter-kernel
```

### Connect to jupyter

```
const connector = new KernelConnector()
connector.connect({
    baseUrl: 'http://127.0.0.1:8888', // Jupyter url
    token: 'token' // Jupyter token
})
```

### Execute code

```
const response = connector.requestExecute({
    code: value || '',
    allow_stdin: true,
    silent: false,
    stop_on_error: true,
    store_history: true,
})
```

### Render execution response

```
<CodeExecuteResponse response={response} />
```

### KernelConnector hook

```
type Props = {
    connector: KernelConnector
}

/*
This component will be rendered when the KernelConnector's runningStatus or connectionState changes.
*/
export default function Something({ connector }: Props) {
    const { runningStatus, connectionState } = useKernelConnector(connector)
    ...
}
```

### Debug window

1. add `DEBUG_JUPYTER_KERNEL` to localStorage
2. render `<DebugWindow kernelConnector={connector}/>`

## When develop this package

## scripts 

```
$ yarn watch
$ cd ./example
$ yarn start
```

## Reference
- jupyterlab github: https://github.com/jupyterlab/jupyterlab
- jupyterlab package들로 제작된 jupyter연결 예제: https://github.com/jupyterlab/jupyterlab/tree/master/packages/services/examples/browser
- monaco editor: https://github.com/microsoft/monaco-editor
- monaco editor react: https://github.com/suren-atoyan/monaco-react

---
_Source: https://npm.io/package/aiffel-jupyter-kernel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
