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.0.tar.gz (980.4 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.0-py3-none-any.whl (627.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: waldiez_jupyter-0.5.0.tar.gz
  • Upload date:
  • Size: 980.4 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.0.tar.gz
Algorithm Hash digest
SHA256 d3491a0dd4f4d3fe04aa78f21dd463e13d404a8ce07de4a57653d7bea4b92b80
MD5 8d22fd1381abcd049b014845de3fc60f
BLAKE2b-256 da839cb20396953f308b680d6f187ccfc233bf2be182445018a841d640ded0ca

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: waldiez_jupyter-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 627.2 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9c3138f0963c239557452c786807b4047a6756bdbf066da41ed926924fa81cea
MD5 377f54e17f21957c41b2ce6b7cd4fb74
BLAKE2b-256 f8442b6e8311436c8cb2a1f457fbb8111cecb0e4914186e23414227b8cf4c970

See more details on using hashes here.

Provenance

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