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.3.10.tar.gz (629.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.3.10-py3-none-any.whl (311.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: waldiez_jupyter-0.3.10.tar.gz
  • Upload date:
  • Size: 629.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.3.10.tar.gz
Algorithm Hash digest
SHA256 b00a6e310e1e2cbd4ee1d7897112cf6695b4bbb37ac8a966f6c2d89432111152
MD5 cc68c2e288a1d4727ebba863f0e98db7
BLAKE2b-256 26624deeb4dc31eadf414683e59b2f465f5027f5928734f40a4a06685de837a6

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for waldiez_jupyter-0.3.10-py3-none-any.whl
Algorithm Hash digest
SHA256 78fb8af39b3254451df72fb638d7f810e33da65e9cb62c3ed4dfc89acdd496eb
MD5 f5ce0c5a33e186191ecf978596810bc0
BLAKE2b-256 713708a3f3f4fd2297d11cc1cbcf9625d6b12868b8e9fd934257affb4f2013bc

See more details on using hashes here.

Provenance

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