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.10.tar.gz (988.5 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.10-py3-none-any.whl (607.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: waldiez_jupyter-0.5.10.tar.gz
  • Upload date:
  • Size: 988.5 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.10.tar.gz
Algorithm Hash digest
SHA256 93b1595453ac1e71f0519a993e3c75c8afc56d0f813c34aa0f33aea1f30e12ea
MD5 82b8ea9470cd1e2cd7f915ba57a039df
BLAKE2b-256 a0478d1440ca64cae9d9a3fc8d1617666840e3aa7bf187bc131d49601fb24cc9

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for waldiez_jupyter-0.5.10-py3-none-any.whl
Algorithm Hash digest
SHA256 1540b1eff2e2bbb674aa7fa93b49e2de0895354a81d0d2199469bf52ae1e1b81
MD5 e9026d97b23af8974c1f18e06b620b6d
BLAKE2b-256 dd12c0b8bdf78b05d41afb1bcbe3fc2708316cae77902515bc92b6e6dc2d8d00

See more details on using hashes here.

Provenance

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