Skip to main content

A JupyterLab extension for rendering Errors with a copy/paste button and expand/collapse

Project description

jupyterlab-skip-traceback

PyPI version PyPI DM Github Actions Status Binder

A JupyterLab extension for rendering Errors with a copy/paste button and expand/collapse.

This is inspired by the notebook version here.

Screenshot

Requirements

  • JupyterLab >= 4.0

Install

pip install jupyterlab-skip-traceback

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab-skip-traceback directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter-labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Publishing

Before starting, you'll need to have run: pip install twine jupyter_packaging

  1. Update the version in package.json and update the release date in CHANGELOG.md
  2. Commit the change in step 1, tag it, then push it
git commit -am <msg>
git tag vX.Z.Y
git push && git push --tags
  1. Create the artifacts
rm -rf dist tsconfig.tsbuildinfo lib jupyterlab-skip-traceback/labextension jupyterlab_skip_traceback-*.tar.gz jupyterlab_skip_traceback-*.whl
hatch build .
  1. Test this against the test pypi. You can then install from here to test as well:gi
twine upload --repository-url https://test.pypi.org/legacy/ jupyterlab_skip_traceback-*.tar.gz jupyterlab_skip_traceback-*.whl
# In a new venv
pip install --index-url https://test.pypi.org/simple/ jupyterlab_skip_traceback
  1. Upload this to pypi:
twine upload jupyterlab_skip_traceback-*.tar.gz jupyterlab_skip_traceback-*.whl

Uninstall

pip uninstall jupyterlab-skip-traceback

History

This plugin was contributed back to the community by the D. E. Shaw group.

D. E. Shaw Logo

License

This project is released under a BSD-3-Clause license.

We love contributions! Before you can contribute, please sign and submit this Contributor License Agreement (CLA). This CLA is in place to protect all users of this project.

"Jupyter" is a trademark of the NumFOCUS foundation, of which Project Jupyter is a part.

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

jupyterlab_skip_traceback-5.1.0.tar.gz (239.7 kB view details)

Uploaded Source

Built Distribution

jupyterlab_skip_traceback-5.1.0-py3-none-any.whl (106.6 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_skip_traceback-5.1.0.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_skip_traceback-5.1.0.tar.gz
Algorithm Hash digest
SHA256 c05086a74c085b0bc47598216c9044f94c2da02a36fb0f369ad0eb17915ef222
MD5 bbf34cade494a4b6bb51c2899ea98b73
BLAKE2b-256 f893f5a4816470b417c7ee1f3c9d2f4b89989d7448a6a8db66f91916d459b023

See more details on using hashes here.

File details

Details for the file jupyterlab_skip_traceback-5.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_skip_traceback-5.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e54f115ec65fab7f7affbd67f95e48e9ba07353cb3199008aa835227bccb7260
MD5 271326930fbb1516c96c8e96b560a1e5
BLAKE2b-256 09fdcd64e02eaeb2afd9c56bad6004c89bed73fee73b4379c320c9696d5b9161

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page