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

📣 🎨
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.5.1.tar.gz (978.7 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.5.1-py3-none-any.whl (625.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for waldiez_jupyter-0.5.1.tar.gz
Algorithm Hash digest
SHA256 ae9623cd8739afd7f8f97dfb53e856ceeccf5507fc4f57e35e22d98f97ab3dfe
MD5 0d4e678ac70e3d4e6032aff7c2d8ea18
BLAKE2b-256 9955adb3f0ca6415493c1ea6335c03e3cbb5b5677f55c9d9db74c13832b7b2a0

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for waldiez_jupyter-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 58d7cdd4050dde6efc3897b066c8a8c94811bdd62b0c32e11bd8248464dfb17b
MD5 f1537887768222c56975668c648a09a8
BLAKE2b-256 619c87040de00b9cd56eed3d68bd17c96126bf0f0861180dd9ded7fa9b78f13e

See more details on using hashes here.

Provenance

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