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.8.tar.gz (983.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.8-py3-none-any.whl (605.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: waldiez_jupyter-0.5.8.tar.gz
  • Upload date:
  • Size: 983.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.8.tar.gz
Algorithm Hash digest
SHA256 f66f6265f6c93b02ff5d3e5f96776a7a09d9ac80221d640177d611293b98d1d3
MD5 1f6e2d40c0f81e22fef88c9877b59eab
BLAKE2b-256 5422ed89afbb1c7aea9b96e3e239a83a847c5cf04b497ca6b32d1881ab0b46c5

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for waldiez_jupyter-0.5.8-py3-none-any.whl
Algorithm Hash digest
SHA256 97634d927b985f5ad6de82c624bf9ee4bb60728fe37965ca5c594cc52110b3a9
MD5 9356370b5193263cdb066b43023ed040
BLAKE2b-256 86ea9a2858cf28de100d8b8a89f8cd67c1899a4c473002b03be39a342850faf1

See more details on using hashes here.

Provenance

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