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.11.tar.gz (629.6 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.11-py3-none-any.whl (312.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: waldiez_jupyter-0.3.11.tar.gz
  • Upload date:
  • Size: 629.6 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.11.tar.gz
Algorithm Hash digest
SHA256 02ea6626289cf5bcaf6735b4e78cde020bed0fb66fc45b1f11baa521006808e7
MD5 f10122d3c3c8c5db2e609981565bd308
BLAKE2b-256 2f8862a950282326b01c74645e6d09f56d673cc35a4379e170fe95e37ec9fc6c

See more details on using hashes here.

Provenance

The following attestation bundles were made for waldiez_jupyter-0.3.11.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.11-py3-none-any.whl.

File metadata

File hashes

Hashes for waldiez_jupyter-0.3.11-py3-none-any.whl
Algorithm Hash digest
SHA256 8b86680653f8afd9fe0e77c9e620cc78e98d8723ba2afeafc69671f1bdcf01ff
MD5 ac755e0c775fc77107b0d30d35e1f54c
BLAKE2b-256 743da36bdd8f658a50e3a91e4f2bd45af5190f9bf6f09863f6959124765476f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for waldiez_jupyter-0.3.11-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