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.3.tar.gz (954.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.5.3-py3-none-any.whl (596.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: waldiez_jupyter-0.5.3.tar.gz
  • Upload date:
  • Size: 954.9 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.3.tar.gz
Algorithm Hash digest
SHA256 84d6100e8bde9754cf2e6e269b4c711a0d17b5af31960d3b9d38ef1a83ec22c6
MD5 9aff4b83d817dc7ab3f916d30477118f
BLAKE2b-256 3fbc6729fc3284f1c6bb8fd090fada36c221f97ecc8e169cb8e481365b49a545

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for waldiez_jupyter-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 09a68e12b68dc8e86fd40cf4665f2cbbe2e246a862d233e59774f3ff1d4cd18c
MD5 95a06ac1471f942ca8340591f2c5374f
BLAKE2b-256 bbb719a21869303eae2f5248f82ae0301a0268e53609263a9d96e6d796fd8e05

See more details on using hashes here.

Provenance

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