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

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.1.tar.gz (633.2 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.1-py3-none-any.whl (315.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: waldiez_jupyter-0.4.1.tar.gz
  • Upload date:
  • Size: 633.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for waldiez_jupyter-0.4.1.tar.gz
Algorithm Hash digest
SHA256 9888053b8162e74890f7ad66eda3370400b06d6d7a3b1e53076a24f615b58610
MD5 bdc02044d331c11d3103e6ab272d7caa
BLAKE2b-256 4c7a634c16db791879b3f5ef1edb68340f12dddc13441ffe275760a925a35355

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: waldiez_jupyter-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 315.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for waldiez_jupyter-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fb0c7300bdf0e447d984427bd51f257e4e91c08e2f2d99867f93651deb9764ea
MD5 87ebb960549011ece344b76bd93b83ad
BLAKE2b-256 7d718bf2dad1de4847112440c01fba4d3200f2cc1ea3eb9fffb86c1fad447548

See more details on using hashes here.

Provenance

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