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.6.tar.gz (650.5 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.6-py3-none-any.whl (337.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for waldiez_jupyter-0.3.6.tar.gz
Algorithm Hash digest
SHA256 a109db3269feb4b17471ac1a523742f5f0ff324d944110c018575606e0a6fe78
MD5 1cd2d01bf15dfe6d0b96fc34e1690a7b
BLAKE2b-256 6d2afa9b85173e2fd9a14a89190431440fc0ff0d7eed38a346fcd2ad385e5b0a

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for waldiez_jupyter-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e2576ce42348cd853f607aa24e854b255321bffb678f33a3929896c1295b6b34
MD5 f6c09e2c14fbbbd2335e87f930cdf1c8
BLAKE2b-256 eed435c03f76d56a48f96974074236c23444da7c36e7a2230426df929f7f715b

See more details on using hashes here.

Provenance

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