Skip to main content

Limit output text mime-renders

Project description

jupyterlab-limit-output

PyPI version PyPI DM Github Actions Status Binder

Limit long text output for a single mime render.

Limit OutputScreenshot

This is inspired by the notebook version here.

Settings

Use Settings->Advanced User Settings->Limit Output to set head and/or tail limits. You can also limit by characters instead of lines. This extension can also be enabled/disabled to allow for site-wide installations.

Note: This works on a per mime render basis. For example, imagine cell that outputs a large number alternating lines of stdout and stderr. This extension won't help because each line would be it's own mime renderer (lab itself will help by limiting the number of renders shown).

Requirements

  • JupyterLab >= 3.0

Install

To install this package with pip run

pip install jupyterlab_limit_output

To install this package with conda run

conda install -c conda-forge jupyterlab_limit_output

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_limit_output 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
python setup.py sdist bdist_wheel
  1. Test this against the test pypi. You can then install from here to test as well:
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
# In a new venv
pip install --index-url https://test.pypi.org/simple/ jupyterlab_limit_output
  1. Upload this to pypi:
twine upload dist/*

Uninstall

pip uninstall jupyterlab_limit_output

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.

"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_limit_output-1.0.0.tar.gz (154.0 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page