| Name | jupyterlab_eventlistener JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A JupyterLab Plugin for listening to Jupyter events in the frontend. |
| upload_time | 2024-11-15 23:55:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License
Copyright (c) 2024, Zach Sailer
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. 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.
3. 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 |
jupyter
jupyterlab
jupyterlab-extension
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# JupyterLab EventListener
[](https://github.com/Zsailer/jupyterlab-eventlistener/actions/workflows/build.yml)
A JupyterLab Plugin for listening to Jupyter events in the frontend.
The API mirrors the [Listener API](https://jupyter-events.readthedocs.io/en/latest/user_guide/listeners.html) in the server-side (Python) Jupyter Events package.
## Basic Usage
Once this extension is installed, another extension can consume the `IEventListener` token and register custom listeners to Jupyter Events.
Below is a basic example of a plugin that "listens" to Kernel Action events from Jupyter Server and shows a toast notification in the UI.
```typescript
import {
Notification
} from '@jupyterlab/apputils';
import { Event } from '@jupyterlab/services';
import { IEventListener } from 'jupyterlab-eventlistener';
const kernelActionEventSchema = "https://events.jupyter.org/jupyter_server/kernel_actions/v1";
type KernelEventType = {
msg: string;
action: string;
kernel_id?: string;
kernel_name?: string;
status?: string;
status_code?: number;
}
async function kernelEventListener(manager, schemaId, event: Event.Emission) => {
let data = (event as KernelEventType);
// Show a notification
let message `The ${kernel_name} kernel with ID ${kernel_id} action ${action} has status ${status}.`
Notification.info(
data.msg,
{
autoClose: 5000,
}
);
}
/**
* The IEventList
*/
const myPlugin: JupyterFrontEndPlugin<void> = {
id: "myplugin",
description: 'A plugin that uses the Event Listener API and shows a notification.',
autoStart: true,
requires: [
IEventListener
],
activate: async (
app: JupyterFrontEnd,
eventListener: IEventListener
) => {
eventListener.addListener(
kernelActionEventSchema,
kernelEventListener
);
}
};
```
## Requirements
- JupyterLab >= 4.0.0
## Install
To install the extension, execute:
```bash
pip install jupyterlab_eventlistener
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall jupyterlab_eventlistener
```
## 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_eventlistener 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 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 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 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
```
### Development uninstall
```bash
pip uninstall jupyterlab_eventlistener
```
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `jupyterlab-eventlistener` within that folder.
### Testing the extension
#### Frontend tests
This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
To execute them, execute:
```sh
jlpm
jlpm test
```
#### Integration tests
This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
More information are provided within the [ui-tests](./ui-tests/README.md) README.
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyterlab_eventlistener",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": null,
"author_email": "Zach Sailer <zachsailer@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/77/b5/eca2bf58966e2a99f9440624fc29e7d8cdf54d892c52f357b575edd97d5e/jupyterlab_eventlistener-0.1.0.tar.gz",
"platform": null,
"description": "# JupyterLab EventListener\n\n[](https://github.com/Zsailer/jupyterlab-eventlistener/actions/workflows/build.yml)\n\nA JupyterLab Plugin for listening to Jupyter events in the frontend.\n\nThe API mirrors the [Listener API](https://jupyter-events.readthedocs.io/en/latest/user_guide/listeners.html) in the server-side (Python) Jupyter Events package.\n\n## Basic Usage\n\nOnce this extension is installed, another extension can consume the `IEventListener` token and register custom listeners to Jupyter Events.\n\nBelow is a basic example of a plugin that \"listens\" to Kernel Action events from Jupyter Server and shows a toast notification in the UI.\n\n```typescript\nimport {\n Notification\n} from '@jupyterlab/apputils';\n\nimport { Event } from '@jupyterlab/services';\nimport { IEventListener } from 'jupyterlab-eventlistener';\n\nconst kernelActionEventSchema = \"https://events.jupyter.org/jupyter_server/kernel_actions/v1\";\n\n\ntype KernelEventType = {\n msg: string;\n action: string;\n kernel_id?: string;\n kernel_name?: string;\n status?: string;\n status_code?: number;\n}\n\n\nasync function kernelEventListener(manager, schemaId, event: Event.Emission) => {\n let data = (event as KernelEventType);\n // Show a notification\n let message `The ${kernel_name} kernel with ID ${kernel_id} action ${action} has status ${status}.`\n Notification.info(\n data.msg,\n {\n autoClose: 5000,\n }\n );\n}\n\n/**\n * The IEventList\n */\nconst myPlugin: JupyterFrontEndPlugin<void> = {\n id: \"myplugin\",\n description: 'A plugin that uses the Event Listener API and shows a notification.',\n autoStart: true,\n requires: [\n IEventListener\n ],\n activate: async (\n app: JupyterFrontEnd,\n eventListener: IEventListener\n ) => {\n\n eventListener.addListener(\n kernelActionEventSchema,\n kernelEventListener\n );\n }\n};\n```\n\n## Requirements\n\n- JupyterLab >= 4.0.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install jupyterlab_eventlistener\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyterlab_eventlistener\n```\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_eventlistener 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 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 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 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### Development uninstall\n\n```bash\npip uninstall jupyterlab_eventlistener\n```\n\nIn development mode, you will also need to remove the symlink created by `jupyter labextension develop`\ncommand. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`\nfolder is located. Then you can remove the symlink named `jupyterlab-eventlistener` within that folder.\n\n### Testing the extension\n\n#### Frontend tests\n\nThis extension is using [Jest](https://jestjs.io/) for JavaScript code testing.\n\nTo execute them, execute:\n\n```sh\njlpm\njlpm test\n```\n\n#### Integration tests\n\nThis extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).\nMore precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.\n\nMore information are provided within the [ui-tests](./ui-tests/README.md) README.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) 2024, Zach Sailer\n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n 1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n 3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "A JupyterLab Plugin for listening to Jupyter events in the frontend.",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/Zsailer/jupyterlab-eventlistener/issues",
"Homepage": "https://github.com/Zsailer/jupyterlab-eventlistener",
"Repository": "https://github.com/Zsailer/jupyterlab-eventlistener.git"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "70360f039cbdbc5376a74bd5ee0d8a64647e1e3427f37a45fa37aaa58140c025",
"md5": "7cec3fa60c6d20e1bcf17e03216655c0",
"sha256": "7fce1b90eb59c47f27a2fa46761212e82f978894384f74ec7bbff67fd8678089"
},
"downloads": -1,
"filename": "jupyterlab_eventlistener-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7cec3fa60c6d20e1bcf17e03216655c0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 36865,
"upload_time": "2024-11-15T23:55:35",
"upload_time_iso_8601": "2024-11-15T23:55:35.854985Z",
"url": "https://files.pythonhosted.org/packages/70/36/0f039cbdbc5376a74bd5ee0d8a64647e1e3427f37a45fa37aaa58140c025/jupyterlab_eventlistener-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "77b5eca2bf58966e2a99f9440624fc29e7d8cdf54d892c52f357b575edd97d5e",
"md5": "6691b02ccc3c8c58fd32e79830d6d006",
"sha256": "16a540b735a3866ba3bf655916392e89d0573225462da9ea4b08f34d23814898"
},
"downloads": -1,
"filename": "jupyterlab_eventlistener-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "6691b02ccc3c8c58fd32e79830d6d006",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 151653,
"upload_time": "2024-11-15T23:55:37",
"upload_time_iso_8601": "2024-11-15T23:55:37.848423Z",
"url": "https://files.pythonhosted.org/packages/77/b5/eca2bf58966e2a99f9440624fc29e7d8cdf54d892c52f357b575edd97d5e/jupyterlab_eventlistener-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-15 23:55:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Zsailer",
"github_project": "jupyterlab-eventlistener",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlab_eventlistener"
}
