| Name | transient-display-data JSON |
| Version |
0.4.4
JSON |
| download |
| home_page | |
| Summary | Extension to display transient_display_data in Jupyter Lab |
| upload_time | 2023-09-15 05:04:44 |
| maintainer | |
| docs_url | None |
| author | Bo Peng |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) Bo Peng and the University of Texas MD Anderson Cancer Center All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://badge.fury.io/js/transient-display-data)
[](https://anaconda.org/conda-forge/jupyterlab-transient-display-data)
# `transient-display-data` for Jupyter Lab
This is a JupyterLab extension that allows JupyterLab to receive messages in a new
[`transient_display_data` type](https://github.com/jupyter/jupyter_client/issues/378)
and display them in the console window of the associted notebook.
As summarized [here](https://github.com/jupyter/jupyter_client/pull/378#issuecomment-386760939),
the transient display data messages are designed to send messages that are transient
in nature and will not be displayed and saved with the notebooks. Such messages
include but not limited to status or progress information for long calculations, and
debug information. This message type is identical to `display_data` in content so you
only need to use message type `transient_display_data` instead of `display_data` to
mark the message as transient.
This new message type is currently under review. However, even before it is officially
accepted, kernels can send messages of this type safely because all Jupyter clients
ignore messages of unknown types, and JupyterLab with this extension will be able to
display them. An an example, the [SoS Kernel](https://github.com/vatlab/sos-notebook)
uses this message type to send progress information during the execution of the
[SoS workflows](https://github.com/vatlab/SoS).
## How to install
* If you are using conda version of JupyterLab, you can install this extension with command
```bash
conda install jupyterlab-transient-display-data -c conda-forge
```
* Otherwise you can install the `transient-display-data` extension using command
```bash
jupyter labextension install transient-display-data
```
or go to the extension manager, search for `transient-display-data`, and install.
## How to use `transient_display_data`
After you installed this extention, you can test it by
1. Create a notebook with Python 3 kernel
2. Right click and select `New Console for Notebook` to create a console window
3. Right click on the console window and you select `Show Transient Message`.
4. In the Python notebook, enter
```
kernel = get_ipython().kernel
kernel.send_response(kernel.iopub_socket,
'transient_display_data',
{
'data': {
'text/plain': 'I am transient'
}
}
);
```
and a message `I am transient` should be displayed in the console window.
5. If you are interested in trying [SoS Notebook](https://vatlab.github.io/sos-docs/), you can click
[this link](http://128.135.144.117:8000/hub/user-redirect/lab) to start
a JupyterLab session on our live server. You can create a new notebook
with SoS kernel, open a console window, and execute for example a trivial workflow
```
%run
[1]
[2]
[3]
```
You can see progress messages in the console window.
Raw data
{
"_id": null,
"home_page": "",
"name": "transient-display-data",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Bo Peng",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/2f/8e/e6259376f56054042c89e9bb1653f058d8136fde4d5bcf41bd0c0c45ae56/transient_display_data-0.4.4.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/js/transient-display-data)\n[](https://anaconda.org/conda-forge/jupyterlab-transient-display-data)\n\n# `transient-display-data` for Jupyter Lab\n\nThis is a JupyterLab extension that allows JupyterLab to receive messages in a new\n[`transient_display_data` type](https://github.com/jupyter/jupyter_client/issues/378)\nand display them in the console window of the associted notebook.\n\nAs summarized [here](https://github.com/jupyter/jupyter_client/pull/378#issuecomment-386760939),\nthe transient display data messages are designed to send messages that are transient\nin nature and will not be displayed and saved with the notebooks. Such messages\ninclude but not limited to status or progress information for long calculations, and\ndebug information. This message type is identical to `display_data` in content so you\nonly need to use message type `transient_display_data` instead of `display_data` to\nmark the message as transient.\n\nThis new message type is currently under review. However, even before it is officially\naccepted, kernels can send messages of this type safely because all Jupyter clients\nignore messages of unknown types, and JupyterLab with this extension will be able to\ndisplay them. An an example, the [SoS Kernel](https://github.com/vatlab/sos-notebook)\nuses this message type to send progress information during the execution of the\n[SoS workflows](https://github.com/vatlab/SoS).\n\n## How to install\n\n* If you are using conda version of JupyterLab, you can install this extension with command\n ```bash\n conda install jupyterlab-transient-display-data -c conda-forge\n ```\n* Otherwise you can install the `transient-display-data` extension using command\n ```bash\n jupyter labextension install transient-display-data\n ```\n or go to the extension manager, search for `transient-display-data`, and install.\n\n## How to use `transient_display_data`\n\nAfter you installed this extention, you can test it by\n\n1. Create a notebook with Python 3 kernel\n2. Right click and select `New Console for Notebook` to create a console window\n3. Right click on the console window and you select `Show Transient Message`.\n4. In the Python notebook, enter\n\n```\nkernel = get_ipython().kernel\nkernel.send_response(kernel.iopub_socket,\n 'transient_display_data',\n {\n 'data': {\n 'text/plain': 'I am transient'\n }\n }\n );\n```\nand a message `I am transient` should be displayed in the console window.\n\n5. If you are interested in trying [SoS Notebook](https://vatlab.github.io/sos-docs/), you can click\n[this link](http://128.135.144.117:8000/hub/user-redirect/lab) to start\na JupyterLab session on our live server. You can create a new notebook\nwith SoS kernel, open a console window, and execute for example a trivial workflow\n\n```\n%run\n[1]\n[2]\n[3]\n```\nYou can see progress messages in the console window.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) Bo Peng and the University of Texas MD Anderson Cancer Center All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Extension to display transient_display_data in Jupyter Lab",
"version": "0.4.4",
"project_urls": {
"Bug Tracker": "https://github.com/vatlab/transient-display-data/issues",
"Homepage": "https://github.com/vatlab/transient-display-data",
"Repository": "https://github.com/vatlab/transient-display-data.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3b6d0695d1fa2307412bcfca192d959e7dd99e4becbe97c554e9d322f893f006",
"md5": "05383e39d431e7719dc65b799831dfb2",
"sha256": "b523bbf405107a569614e62c4571e0aa6e813aa02e5777c6e5d8b89259910644"
},
"downloads": -1,
"filename": "transient_display_data-0.4.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "05383e39d431e7719dc65b799831dfb2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 39129,
"upload_time": "2023-09-15T05:04:42",
"upload_time_iso_8601": "2023-09-15T05:04:42.272459Z",
"url": "https://files.pythonhosted.org/packages/3b/6d/0695d1fa2307412bcfca192d959e7dd99e4becbe97c554e9d322f893f006/transient_display_data-0.4.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2f8ee6259376f56054042c89e9bb1653f058d8136fde4d5bcf41bd0c0c45ae56",
"md5": "48acef11e2c8e92ad49c9ddcc6116239",
"sha256": "cb9dc673c66cb5ef6d79039e0e261cea3737a06a9e918d5781e1be85d7075f7f"
},
"downloads": -1,
"filename": "transient_display_data-0.4.4.tar.gz",
"has_sig": false,
"md5_digest": "48acef11e2c8e92ad49c9ddcc6116239",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 221121,
"upload_time": "2023-09-15T05:04:44",
"upload_time_iso_8601": "2023-09-15T05:04:44.135666Z",
"url": "https://files.pythonhosted.org/packages/2f/8e/e6259376f56054042c89e9bb1653f058d8136fde4d5bcf41bd0c0c45ae56/transient_display_data-0.4.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-15 05:04:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vatlab",
"github_project": "transient-display-data",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "transient-display-data"
}
