# jupyter-transport-wrapper

> A thin wrapper abstracting over ZMQ and (evenutally) websockets for Jupyter

Latest version **0.0.1** (published 2015-07-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install jupyter-transport-wrapper
pnpm add jupyter-transport-wrapper
yarn add jupyter-transport-wrapper
bun add jupyter-transport-wrapper
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2015-07-24 |
| First published | 2015-07-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Will Whitney |
| Maintainers | wfwhitney |

## Links

- npm: https://www.npmjs.com/package/jupyter-transport-wrapper
- Repository: https://github.com/nteract/jupyter-transport-wrapper
- Issues: https://github.com/nteract/jupyter-transport-wrapper/issues
- npm.io page: https://npm.io/package/jupyter-transport-wrapper

## Dependencies (3)

- [jmp](https://npm.io/package/jmp.md) ^0.2.0
- [uuid](https://npm.io/package/uuid.md) ^2.0.1
- [eventemitter2](https://npm.io/package/eventemitter2.md) ^0.4.14

## Recent versions

- 0.0.1 (latest) — 2015-07-24

## README

# jupyter-transport-wrapper

Currently just provides a very simple layer on top of Jupyter ZMQ sockets. Will one day abstract over ZMQ or websockets for Jupyter.

Probably easier to use [jupyter-session](https://github.com/nteract/jupyter-session), which is built on this, for whatever you're doing.

## Usage

```javascript
var JupyterTransport = require('jupyter-session');

transport = new JupyterTransport(
    {
        version: 5,
        signature_scheme: 'sha256',
        key: '<the signing key>',
        transport: 'tcp',
        ip: '127.0.0.1',
        hb_port: 60868,
        control_port: 60869,
        shell_port: 60870,
        stdin_port: 60871,
        iopub_port: 60872
    },
    <'handle to kernel process, if available'>
);

// use wildcards to get all messages on a channel
transport.on('shell.*', function(message) {
    // message will be a jmp.Message
});

// send a JSON-formatted Jupyter message over the given channel
transport.send(channel, message);

// send the kernel an interrupt
transport.interrupt();

// close the sockets and kill the kernel
transport.close();
```

JupyterTransport is an EventEmitter, so you can use any of these methods: https://github.com/asyncly/EventEmitter2

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