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 10000:8888 \
  -v ${PWD}/notebooks:/home/user/notebooks \
  ghcr.io/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/user/notebooks \
  --userns=keep-id \
  --security-opt label=disable ghcr.io/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).

Project details


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.4.3.tar.gz (681.1 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.4.3-py3-none-any.whl (358.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: waldiez_jupyter-0.4.3.tar.gz
  • Upload date:
  • Size: 681.1 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.4.3.tar.gz
Algorithm Hash digest
SHA256 6d1c8d103c382ed1027de97278c66af2213d44820d97958cfd1ada2c2b6630a7
MD5 a2339d9af1ee14bb19467934aacfb71a
BLAKE2b-256 cc01e00689c037ae3a8ca18f5122f5492743449de684c186e798e9eb013b1c15

See more details on using hashes here.

Provenance

The following attestation bundles were made for waldiez_jupyter-0.4.3.tar.gz:

Publisher: release.yaml on waldiez/waldiez

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.4.3-py3-none-any.whl.

File metadata

  • Download URL: waldiez_jupyter-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 358.3 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.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ba8b8a05cc2b3c7b4f2d6dcf36198fb6fdeea47e09f571ceadeee4e1191f73d3
MD5 3ba54a32bf45f31fa027df80e9343a5e
BLAKE2b-256 70f055e7209b275bb68850237f9e71cf424a3e8d0c6ce51b742afc89e093e91c

See more details on using hashes here.

Provenance

The following attestation bundles were made for waldiez_jupyter-0.4.3-py3-none-any.whl:

Publisher: release.yaml on waldiez/waldiez

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