# jupyterlab_wall
A JupyterLab extension to alert users of system events.
This extension is composed of a Python package named `jupyterlab_wall`
for the server extension and a NPM package named `jupyterlab-wall`
for the frontend extension.
## Requirements
* JupyterLab >= 3.0 < 4
## Install
```bash
pip install jupyterlab_wall
```
You will also need to define a set of alerts that should trigger, see 'jupyter_jupyterlab_wall_config.py' for examples.
This config needs to be incorporated into your jupyter_server_config.py from one of the jupyter config paths
to take effect. You can define a new jupyter_server_config.py with the contents of 'jupyter_jupyterlab_wall_config.py'.
You can see all the jupyter paths with:
```bash
jupyter --paths
```
As an example, you could copy the example alerts into your ${HOME}/.jupyter/ directory.
```bash
cp ./jupyter_jupyterlab_wall_config.py ${HOME}/.jupyter/jupyter_server_config.py
```
OR, append the example alerts to an existing file.
```bash
cat ./jupyter_jupyterlab_wall_config.py >> ${HOME}/.jupyter/jupyter_server_config.py
```
## Troubleshoot
If you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:
```bash
jupyter server extension list
```
If the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:
```bash
jupyter labextension list
```
You can check to see what the current alerts config is:
```bash
jupyter server --show-config
```
If there are no alerts confined, a test_alert is defined internally that you can use to verify that the extension is
working. You can create the file '/tmp/alert_test', which will trigger an alert in jupyterlab if the extension
is working correctly.
## 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_wall 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_wall
```
Raw data
{
"_id": null,
"home_page": "https://github.com/mlhenderson/jupyterlab_wall",
"name": "jupyterlab-wall",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Jupyter, JupyterLab, JupyterLab3",
"author": "Matt Henderson",
"author_email": null,
"download_url": null,
"platform": "Linux",
"description": "# jupyterlab_wall\n\n\n\nA JupyterLab extension to alert users of system events.\n\n\nThis extension is composed of a Python package named `jupyterlab_wall`\nfor the server extension and a NPM package named `jupyterlab-wall`\nfor the frontend extension.\n\n\n## Requirements\n\n* JupyterLab >= 3.0 < 4\n\n## Install\n\n```bash\npip install jupyterlab_wall\n```\n\nYou will also need to define a set of alerts that should trigger, see 'jupyter_jupyterlab_wall_config.py' for examples.\nThis config needs to be incorporated into your jupyter_server_config.py from one of the jupyter config paths\nto take effect. You can define a new jupyter_server_config.py with the contents of 'jupyter_jupyterlab_wall_config.py'.\n\nYou can see all the jupyter paths with:\n```bash\njupyter --paths\n```\n\nAs an example, you could copy the example alerts into your ${HOME}/.jupyter/ directory.\n```bash\ncp ./jupyter_jupyterlab_wall_config.py ${HOME}/.jupyter/jupyter_server_config.py\n```\n\nOR, append the example alerts to an existing file.\n```bash\ncat ./jupyter_jupyterlab_wall_config.py >> ${HOME}/.jupyter/jupyter_server_config.py\n```\n\n## Troubleshoot\n\nIf you are seeing the frontend extension, but it is not working, check\nthat the server extension is enabled:\n\n```bash\njupyter server extension list\n```\n\nIf the server extension is installed and enabled, but you are not seeing\nthe frontend extension, check the frontend extension is installed:\n\n```bash\njupyter labextension list\n```\n\nYou can check to see what the current alerts config is:\n```bash\njupyter server --show-config\n```\n\nIf there are no alerts confined, a test_alert is defined internally that you can use to verify that the extension is\nworking. You can create the file '/tmp/alert_test', which will trigger an alert in jupyterlab if the extension\nis working correctly.\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_wall 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_wall\n```\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A JupyterLab extension to alert users of system events.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/mlhenderson/jupyterlab_wall"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8fdd8a59c4bb02ce93a5692b64069abb4eca4b3f53af53770ea68b820ac0c289",
"md5": "34998eb6a73b66a333230f7dfd6df2f8",
"sha256": "871c520b37c9170780a08b28ca36c205d376ce6adf983849593becfa78bbf859"
},
"downloads": -1,
"filename": "jupyterlab_wall-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "34998eb6a73b66a333230f7dfd6df2f8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 52272,
"upload_time": "2024-04-16T00:46:46",
"upload_time_iso_8601": "2024-04-16T00:46:46.922567Z",
"url": "https://files.pythonhosted.org/packages/8f/dd/8a59c4bb02ce93a5692b64069abb4eca4b3f53af53770ea68b820ac0c289/jupyterlab_wall-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 00:46:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mlhenderson",
"github_project": "jupyterlab_wall",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlab-wall"
}
JSON
