| Name | jupyterlab-kernelspy JSON |
| Version |
4.0.0
JSON |
| download |
| home_page | |
| Summary | A Jupyter Lab extension for inspecting messages to/from a kernel |
| upload_time | 2023-08-30 15:49:24 |
| maintainer | |
| docs_url | None |
| author | Vidar Tonaas Fauske |
| requires_python | >=3.8 |
| license | # Licensing terms This project is licensed under the terms of the Modified BSD License (also known as New or Revised or 3-Clause BSD), as follows: - Copyright (c) 2018-, Simula Research Laboratory 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 Simula Research 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 OWNER 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.
|
# jupyterlab-kernelspy
[](https://jupyterlab-contrib.github.io/)
[](https://github.com/jupyterlab-contrib/jupyterlab-kernelspy/actions?query=workflow%3ABuild)
[](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-kernelspy/master?urlpath=lab) [](https://pypi.org/project/jupyterlab-kernelspy)
A Jupyter Lab extension for inspecting messages to/from a kernel.
## Requirements
- JupyterLab
## Install
```bash
pip install jupyterlab-kernelspy
```
## Update
From JupyterLab 3.0 onwards, extensions are distributed as Python packages. Use the same Python
package manager you used to install the extension to update it.
For JupyterLab 0.34 - 2.2.x, you can update the extension to the latest compatible version with:
```bash
jupyter labextension update jupyterlab-kernelspy
```
## Usage
Once the extension is installed, it should add a button to your notebook toolbar (a yellow `{:}` icon).
Click this button to open a log view for that notebook.
## Contributing
### Development install
Note: You will need NodeJS to build the extension package.
The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# Clone the repo to your local environment
# Change directory to the jupyterlab-kernelspy 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.
```bash
# 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:
```bash
jupyter lab build --minimize=False
```
### Uninstall
```bash
pip uninstall jupyterlab-kernelspy
```
Raw data
{
"_id": null,
"home_page": "",
"name": "jupyterlab-kernelspy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Vidar Tonaas Fauske",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/9e/56/49af45c4d0811a4715ee9b1cdc093553884be6859558825d7faa27c352ae/jupyterlab_kernelspy-4.0.0.tar.gz",
"platform": null,
"description": "# jupyterlab-kernelspy\n\n[](https://jupyterlab-contrib.github.io/)\n[](https://github.com/jupyterlab-contrib/jupyterlab-kernelspy/actions?query=workflow%3ABuild)\n[](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-kernelspy/master?urlpath=lab) [](https://pypi.org/project/jupyterlab-kernelspy)\n\nA Jupyter Lab extension for inspecting messages to/from a kernel.\n\n\n\n## Requirements\n\n- JupyterLab\n\n## Install\n\n```bash\npip install jupyterlab-kernelspy\n```\n\n## Update\n\nFrom JupyterLab 3.0 onwards, extensions are distributed as Python packages. Use the same Python\npackage manager you used to install the extension to update it.\n\nFor JupyterLab 0.34 - 2.2.x, you can update the extension to the latest compatible version with:\n\n```bash\njupyter labextension update jupyterlab-kernelspy\n```\n\n## Usage\n\nOnce the extension is installed, it should add a button to your notebook toolbar (a yellow `{:}` icon).\nClick this button to open a log view for that notebook.\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\n\nThe `jlpm` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `jlpm` below.\n\n```bash\n# Clone the repo to your local environment\n# Change directory to the jupyterlab-kernelspy directory\n# Install package in development mode\npip install -e .\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Rebuild extension Typescript source after making changes\njlpm run build\n```\n\nYou 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.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\njlpm run watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nWith 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).\n\nBy 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:\n\n```bash\njupyter lab build --minimize=False\n```\n\n### Uninstall\n\n```bash\npip uninstall jupyterlab-kernelspy\n```\n",
"bugtrack_url": null,
"license": "# Licensing terms This project is licensed under the terms of the Modified BSD License (also known as New or Revised or 3-Clause BSD), as follows: - Copyright (c) 2018-, Simula Research Laboratory 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 Simula Research 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 OWNER 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": "A Jupyter Lab extension for inspecting messages to/from a kernel",
"version": "4.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/jupyterlab-contrib/jupyterlab-kernelspy/issues",
"Homepage": "https://github.com/jupyterlab-contrib/jupyterlab-kernelspy",
"Repository": "https://github.com/jupyterlab-contrib/jupyterlab-kernelspy.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d2ee5bb814d9619ddd4cb0c7ccbaff9b740782618c5858163a1d2c03857c0922",
"md5": "32a99bc20d9209aff9e4a598b8219711",
"sha256": "967b6b1ec1ed3e412921957a8303370a61110d7ec25e839e60d4297a5f8da014"
},
"downloads": -1,
"filename": "jupyterlab_kernelspy-4.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "32a99bc20d9209aff9e4a598b8219711",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 33666,
"upload_time": "2023-08-30T15:49:23",
"upload_time_iso_8601": "2023-08-30T15:49:23.050612Z",
"url": "https://files.pythonhosted.org/packages/d2/ee/5bb814d9619ddd4cb0c7ccbaff9b740782618c5858163a1d2c03857c0922/jupyterlab_kernelspy-4.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9e5649af45c4d0811a4715ee9b1cdc093553884be6859558825d7faa27c352ae",
"md5": "9efcbedeeec28323d766cde567e80786",
"sha256": "f36ed0f1adf0adfa99ff30eaa88e4fcef645c6822588eefb8c0bb08a18929aa0"
},
"downloads": -1,
"filename": "jupyterlab_kernelspy-4.0.0.tar.gz",
"has_sig": false,
"md5_digest": "9efcbedeeec28323d766cde567e80786",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 173288,
"upload_time": "2023-08-30T15:49:24",
"upload_time_iso_8601": "2023-08-30T15:49:24.793867Z",
"url": "https://files.pythonhosted.org/packages/9e/56/49af45c4d0811a4715ee9b1cdc093553884be6859558825d7faa27c352ae/jupyterlab_kernelspy-4.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-30 15:49:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jupyterlab-contrib",
"github_project": "jupyterlab-kernelspy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlab-kernelspy"
}
