Limit output text mime-renders
Limit long text output for a single mime render.
This is inspired by the notebook version here.
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).
- JupyterLab >= 3.0
To install this package with
pip install jupyterlab_limit_output
To install this package with
conda install -c conda-forge jupyterlab_limit_output
Note: You will need NodeJS to build the extension package.
jlpm command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
npm in lieu of
# 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
Before starting, you'll need to have run:
pip install twine jupyter_packaging
- Update the version in
package.jsonand update the release date in
- 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
- Create the artifacts
rm -rf dist python setup.py sdist bdist_wheel
- 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
- Upload this to pypi:
twine upload dist/*
pip uninstall jupyterlab_limit_output
This plugin was contributed back to the community by the D. E. Shaw group.
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.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for jupyterlab_limit_output-1.0.0.tar.gz
Hashes for jupyterlab_limit_output-1.0.0-py3-none-any.whl