# @treezjs/workspace_module

> Looks for a JavaScript file 'workspace.js' in the workspace folder (=notebook-dir) and tries to load it as ES6 module. You can adapt the content of 'workspace.js' to your needs.

Latest version **0.1.0** (published 2024-01-29) · 0 weekly downloads

## Install

```sh
npm install @treezjs/workspace_module
pnpm add @treezjs/workspace_module
yarn add @treezjs/workspace_module
bun add @treezjs/workspace_module
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2024-01-29 |
| First published | 2020-12-10 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Stefan Eidelloth |
| Maintainers | treezjs |
| Keywords | jupyter, jupyterlab, jupyterlab-extension, workspace_module, treez, treezjs |

## Links

- npm: https://www.npmjs.com/package/@treezjs/workspace_module
- Homepage: https://github.com/stefaneidelloth/workspace_module
- npm.io page: https://npm.io/package/@treezjs/workspace_module

## Dependencies (4)

- [jquery](https://npm.io/package/jquery.md) 3.7.0
- [@jupyterlab/apputils](https://npm.io/package/@jupyterlab/apputils.md) 4.1.11
- [@jupyterlab/notebook](https://npm.io/package/@jupyterlab/notebook.md) 4.0.11
- [@jupyterlab/filebrowser](https://npm.io/package/@jupyterlab/filebrowser.md) 4.0.11

## Recent versions

- 0.1.0 (latest) — 2024-01-29
- 0.0.9 — 2023-06-04
- 0.0.7 — 2022-02-22
- 0.0.6 — 2021-12-26
- 0.0.5 — 2021-12-26
- 0.0.4 — 2021-12-20
- 0.0.3 — 2021-11-15
- 0.0.2 — 2021-01-13
- 0.0.1 — 2020-12-10

## README

# workspace_module

Looks for a JavaScript file 'workspace.js' in the workspace folder (=notebook-dir) and
tries to load it as ES6 module. You can adapt the content of 'workspace.js' to your needs.


## Prerequisites

* JupyterLab

## Installation

To install using pip:

```bash
jupyter labextension install @treezjs/workspace_module
```

If jupyter can not be found please make sure to include it in your system PATH variable.

## Development

For a development install (requires npm version 4 or later), do the following in the repository directory:

```bash
# Clone the repo to your local environment
# Move to workspace_module directory
# Install dependencies
npm install
# Install your development version of the extension
jupyter labextension install .
```

If jupyter can not be found please make sure to include it in your system PATH variable.

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

```bash
# Run jupyterlab in watch mode
jupyter lab --watch
```

Now every change will be built locally and bundled into JupyterLab.
Be sure to refresh your browser page after saving file changes to reload the extension
(note: you'll need to wait for webpack to finish, which can take 10s+ at times).

### Uninstall

```bash
jupyter labextension uninstall @treezjs/workspace_module
```

### nmp

In order to publish this jupyterlab extension on npm run:
```bash
npm login   
npm publish
```

(User treezjs)

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