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 8888:8888 \
  -v ${PWD}/notebooks:/home/waldiez/notebooks \
  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/waldiez/notebooks \
  --userns=keep-id \
  --security-opt label=disable 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

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Panagiotis Kasnesis
Panagiotis Kasnesis

📆 🔬
Lazaros Toumanidis
Lazaros Toumanidis

💻
Stella Ioannidou
Stella Ioannidou

📣 🎨
Amalia Contiero
Amalia Contiero

💻 🐛
Christos Chatzigeorgiou
Christos Chatzigeorgiou

💻
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

License

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

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.6.7.tar.gz (997.2 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.6.7-py3-none-any.whl (586.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for waldiez_jupyter-0.6.7.tar.gz
Algorithm Hash digest
SHA256 1b4283b8e6f8caa9732e4093fe5a26eda4ddaa26316869bc620e3373ed28a4b7
MD5 f9aa23b97c4262c79dbfe70d4af34d4d
BLAKE2b-256 c439adab310a54f8a983803d11a9e0bafc73cfc641d5e4edd805f5a0c3cfab08

See more details on using hashes here.

Provenance

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

Publisher: publish.yaml on waldiez/jupyter

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.6.7-py3-none-any.whl.

File metadata

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

File hashes

Hashes for waldiez_jupyter-0.6.7-py3-none-any.whl
Algorithm Hash digest
SHA256 8e9a807705ec201901e66129c0ebbd756cd41f961fe6e182f4ee4d4839458dd0
MD5 7b3d71fc64573ad8484852358ce068e3
BLAKE2b-256 23102eee02b6392a48cbe6fa91dcfd52ef4b51147f347ce9fbcfe65c885e8703

See more details on using hashes here.

Provenance

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

Publisher: publish.yaml on waldiez/jupyter

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