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

Uploaded Python 3

File details

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

File metadata

  • Download URL: waldiez_jupyter-0.5.9.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.9.tar.gz
Algorithm Hash digest
SHA256 95258721d201ddffa71bf223b61e100f66082348e335f1639f2548ed1c1e80f4
MD5 2f3b0cdcb0cd5950bee27f3815549d11
BLAKE2b-256 bbaa5ff848c589918c0743f58b806445d90b9b61c944cbb0b54776808cfdc83d

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for waldiez_jupyter-0.5.9-py3-none-any.whl
Algorithm Hash digest
SHA256 cc51e57c8e4fe6d4943e608b11a1618e8a95c2566ed54eb539ab1f9e24cf78de
MD5 4e97dba2dafdf71c14cd26b014c41592
BLAKE2b-256 e8497e6e8a637c8aaecc0c5acfd2c5ae13b8fd4b5bf96d78bbaba994770f3c5c

See more details on using hashes here.

Provenance

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