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.12.tar.gz (630.4 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.12-py3-none-any.whl (312.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: waldiez_jupyter-0.3.12.tar.gz
  • Upload date:
  • Size: 630.4 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.12.tar.gz
Algorithm Hash digest
SHA256 484c25a6f53a272bfc75d422dc01c29aca0e2a2d9b1d2ae999d642dec07c676e
MD5 64be0b45233ed086af78155bee322f94
BLAKE2b-256 9d09ca90a83a3227600e09d53757efda5e0e570a1435322c35500fec294f2654

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for waldiez_jupyter-0.3.12-py3-none-any.whl
Algorithm Hash digest
SHA256 15da053c56ecd7700a6c95afe2836623e1d52eb6c7cb6c339a46803f96cd912f
MD5 b159b7b46bb4deb3ac3abfb41c6861d4
BLAKE2b-256 2a14015267d01084d27b2434f7908b12c8e9fab34c3d40f5e745123a0c0281d4

See more details on using hashes here.

Provenance

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