# jupyter-jacdac

> Connect to Jacdac devices from JupyterLab

Latest version **1.1.4** (published 2021-05-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install jupyter-jacdac
pnpm add jupyter-jacdac
yarn add jupyter-jacdac
bun add jupyter-jacdac
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.4 |
| Published | 2021-05-24 |
| First published | 2020-09-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 18 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Microsoft Corporation |
| Maintainers | kindscript |
| Keywords | jupyter, jupyterlab, jupyterlab-extension, Jacdac, embedded, TinyML, TensorFlow, TensorFlow Lite |

## Links

- npm: https://www.npmjs.com/package/jupyter-jacdac
- Repository: https://github.com/microsoft/jupyter-jacdac
- Issues: https://github.com/microsoft/jupyter-jacdac/issues
- npm.io page: https://npm.io/package/jupyter-jacdac

## Dependencies (7)

- [@lumino/widgets](https://npm.io/package/@lumino/widgets.md) ^1.14.0
- [@jupyterlab/apputils](https://npm.io/package/@jupyterlab/apputils.md) ^2.0.2
- [@jupyterlab/launcher](https://npm.io/package/@jupyterlab/launcher.md) ^2.0.2
- [@jupyterlab/mainmenu](https://npm.io/package/@jupyterlab/mainmenu.md) ^2.0.2
- [@jupyterlab/notebook](https://npm.io/package/@jupyterlab/notebook.md) ^2.0.2
- [@semantic-release/exec](https://npm.io/package/@semantic-release/exec.md) ^5.0.0
- [@jupyterlab/application](https://npm.io/package/@jupyterlab/application.md) ^2.0.2

## Alternatives

- [monaco-yaml](https://npm.io/package/monaco-yaml.md) — 420.1K weekly downloads
- [@crewx/workflow](https://npm.io/package/@crewx/workflow.md) — 3.1K weekly downloads
- [yaml-cat](https://npm.io/package/yaml-cat.md) — 38 weekly downloads
- [nunjucks-in-yaml](https://npm.io/package/nunjucks-in-yaml.md) — 9 weekly downloads
- [shopify-symlinks](https://npm.io/package/shopify-symlinks.md) — 3 weekly downloads

## Recent versions

- 1.1.4 (latest) — 2021-05-24
- 1.1.2 — 2020-10-16
- 1.1.1 — 2020-10-16
- 1.1.0 — 2020-10-15
- 1.0.12 — 2020-09-22
- 1.0.11 — 2020-09-22
- 1.0.10 — 2020-09-21
- 1.0.9 — 2020-09-21
- 1.0.8 — 2020-09-17
- 1.0.7 — 2020-09-17
- 1.0.6 — 2020-09-17
- 1.0.5 — 2020-09-17
- 1.0.4 — 2020-09-16
- 1.0.3 — 2020-09-16
- 1.0.2 — 2020-09-11
- … 1 more at https://npm.io/package/jupyter-jacdac/versions

## README

# jupyter-jacdac

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/microsoft/jupyter-jacdac/main?urlpath=lab)

This project contains a Microsoft [Jacdac](https://aka.ms/jacdac) extension for [Jupyter Lab](https://jupyter.org/).
The extension allows to collect data from embedded devices and push ML model back into them.

* More information at https://microsoft.github.io/jacdac-ts/tools/jupyterlab/

## Requirements

* JupyterLab >= 2.0

## Install

The extensions package is hosted on [NPMJS](https://www.npmjs.com/package/jupyter-jacdac).

```bash
jupyter labextension install jupyter-jacdac
```

### Uninstall

```bash
jupyter labextension uninstall jupyter-jacdac
```

## Contributing

The extension essentially loads https://microsoft.github.io/jacdac-ts and interacts with this web site via IFrame messages. The UI integration into JupyterLab is kept to an absolute minimum.

### Install

The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` in lieu of `jlpm` below.

```bash
# Clone the repo to your local environment
# Move to jacdac directory
# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build
```

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

```bash
# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch
```

# Contributing

This project welcomes contributions and suggestions.  Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

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