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.6.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.6-py3-none-any.whl (586.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: waldiez_jupyter-0.6.6.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.6.tar.gz
Algorithm Hash digest
SHA256 01ced7e8763426da1167598e4ed63f64f3fe89a837dd7d7293b9bab0b18f5b59
MD5 e31bf31b08391c809c40f8ce4c2edcbd
BLAKE2b-256 0a54efdbed0cc3cd7e1aeaa40395c852c0238903c51d9aecadd315006145b257

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: waldiez_jupyter-0.6.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 f78a063e3efd3d38475e23f94de2cb30194c286e6953a8e7081a5141bbf4ca0d
MD5 93d910dcf26c00c62ef44ee297de0e44
BLAKE2b-256 3e071df65cd6228f775f3dfd42c78994ca423c0c6693bd9fa85c06b7d932a831

See more details on using hashes here.

Provenance

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