Skip to main content

A Waldiez JupyterLab extension.

Project description

@waldiez/jupyter

CI Build Coverage Status PyPI version

A Waldiez JupyterLab extension.

Overview

This extension is composed of a Python package named waldiez-jupyter for the server extension and a NPM package named @waldiez/jupyter for the frontend extension.

Quick Start

Using docker:

CONTAINER_COMMAND=docker # or podman
$CONTAINER_COMMAND run \
  --rm \
  -it \
  -p 10000:8888 \
  -v ${PWD}/notebooks:/home/user/notebooks \
  ghcr.io/waldiez/jupyter:latest

# with selinux and/or podman, you might get permission errors, so you can try:
$CONTAINER_COMMAND run \
  --rm \
  -it \
  -p 10000:8888 \
  -v ${PWD}/notebooks:/home/user/notebooks \
  --userns=keep-id \
  --security-opt label=disable ghcr.io/waldiez/jupyter:latest

Then open your browser at http://localhost:10000 and you should see the JupyterLab interface.

Optional environment variables for the container:

# no password or token by default
JUPYTER_PASSWORD=
JUPYTER_TOKEN=

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

## if not already, install jupyter:
# pip install jupyter
pip install waldiez-jupyter
## you can now start jupyter lab:
# jupyter lab

Uninstall

To remove the extension, execute:

pip uninstall waldiez_jupyter

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

License

This project is licensed under the Apache License, Version 2.0 (Apache-2.0).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

waldiez_jupyter-0.3.7.tar.gz (624.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

waldiez_jupyter-0.3.7-py3-none-any.whl (308.8 kB view details)

Uploaded Python 3

File details

Details for the file waldiez_jupyter-0.3.7.tar.gz.

File metadata

  • Download URL: waldiez_jupyter-0.3.7.tar.gz
  • Upload date:
  • Size: 624.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for waldiez_jupyter-0.3.7.tar.gz
Algorithm Hash digest
SHA256 fd4b29432e379eeff59aa88d54704fba04d43c29b06c8518217ed88924117f62
MD5 ecf5c60c4d31cfa6f938e312bc9814ee
BLAKE2b-256 074087e2e41ffc1dc1dffe1ac149efcc35d52bdca3c4a66742ccd6ffa8388ee2

See more details on using hashes here.

Provenance

The following attestation bundles were made for waldiez_jupyter-0.3.7.tar.gz:

Publisher: release.yaml on waldiez/waldiez

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file waldiez_jupyter-0.3.7-py3-none-any.whl.

File metadata

  • Download URL: waldiez_jupyter-0.3.7-py3-none-any.whl
  • Upload date:
  • Size: 308.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for waldiez_jupyter-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 b960a9b7cc32192dfd03c1839833dfc4fc470ef0fc93dd7000dcf72c10e2d935
MD5 86947ab9c4950f9034940d335d2fc50a
BLAKE2b-256 d5ec46278f15fc4f331c2737733c12541eb7d5fb510cac02f9786c432810942b

See more details on using hashes here.

Provenance

The following attestation bundles were made for waldiez_jupyter-0.3.7-py3-none-any.whl:

Publisher: release.yaml on waldiez/waldiez

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page