{"id":24835709,"url":"https://github.com/mwakaba2/jupyterlab-notifications","last_synced_at":"2025-07-08T06:07:01.127Z","repository":{"id":46963632,"uuid":"332545154","full_name":"mwakaba2/jupyterlab-notifications","owner":"mwakaba2","description":"Jupyterlab extension to show notebook cell completion notifications","archived":false,"fork":false,"pushed_at":"2023-11-15T15:35:44.000Z","size":63197,"stargazers_count":58,"open_issues_count":6,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-01T11:52:46.679Z","etag":null,"topics":["browser-notifications","code-execution","email-notifications","jupyter","jupyter-notifications","jupyterlab","jupyterlab-extension","jupyterlab-notifications","labextension","mobile-notification","mobile-notifications","notification","slack-notifications","telegram","telegram-notification"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mwakaba2.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-01-24T20:10:12.000Z","updated_at":"2025-06-12T15:09:28.000Z","dependencies_parsed_at":"2023-11-15T16:47:39.181Z","dependency_job_id":null,"html_url":"https://github.com/mwakaba2/jupyterlab-notifications","commit_stats":{"total_commits":88,"total_committers":5,"mean_commits":17.6,"dds":"0.17045454545454541","last_synced_commit":"d54a1609d7e2967886f60f4ab698bb45d4b1cd19"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/mwakaba2/jupyterlab-notifications","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mwakaba2%2Fjupyterlab-notifications","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mwakaba2%2Fjupyterlab-notifications/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mwakaba2%2Fjupyterlab-notifications/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mwakaba2%2Fjupyterlab-notifications/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mwakaba2","download_url":"https://codeload.github.com/mwakaba2/jupyterlab-notifications/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mwakaba2%2Fjupyterlab-notifications/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264207136,"owners_count":23572736,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["browser-notifications","code-execution","email-notifications","jupyter","jupyter-notifications","jupyterlab","jupyterlab-extension","jupyterlab-notifications","labextension","mobile-notification","mobile-notifications","notification","slack-notifications","telegram","telegram-notification"],"created_at":"2025-01-31T04:51:25.623Z","updated_at":"2025-07-08T06:07:01.106Z","avatar_url":"https://github.com/mwakaba2.png","language":"Jupyter Notebook","funding_links":[],"categories":["JupyterLab Extensions"],"sub_categories":[],"readme":"# jupyterlab-notifications\n\n![Github Actions Status](https://github.com/mwakaba2/jupyterlab-notifications/workflows/Build/badge.svg)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/mwakaba2/jupyterlab-notifications/main?urlpath=lab/tree/tutorial/py3_demo.ipynb)\n[![PyPI](https://img.shields.io/pypi/v/jupyterlab-notifications.svg)](https://pypi.org/project/jupyterlab-notifications)\n[![npm](https://img.shields.io/npm/v/jupyterlab-notifications.svg)](https://www.npmjs.com/package/jupyterlab-notifications)\n[![Conda Version](https://img.shields.io/conda/vn/conda-forge/jupyterlab-notifications.svg)](https://anaconda.org/conda-forge/jupyterlab-notifications)\n\n### Notebook Cell Completion Notifications for JupyterLab.\n\nOption to get notebook cell completion notifications via browser, slack, mobile, telegram, and many more!\n\n_Image of successful notebook cell execution browser notification_\n\n\u003cimg width=\"387\" alt=\"notification\" src=\"https://user-images.githubusercontent.com/3497137/118382531-3275eb80-b5bc-11eb-9810-5b92183609c3.png\"\u003e\n\n_Image of failed notebook cell execution browser notification_ (Available only in \u003e= v0.3.0)\n\n\u003cimg width=\"389\" alt=\"error_notification\" src=\"https://user-images.githubusercontent.com/3497137/126079534-cd2425be-3b2b-4410-b951-91f54c25ad6a.png\"\u003e\n\n_Image of last selected notebook cell execution browser notification_ (Available only in \u003e= v0.3.0)\n\n\u003cimg width=\"394\" alt=\"last_selected_notebook_cell_notification\" src=\"https://user-images.githubusercontent.com/3497137/127746862-79012afd-caa7-4319-930d-7acfc74fa2f4.png\"\u003e\n\n_Image of mobile phone notifications using `ntfy` + Pushover_\n\n\u003cp float=\"left\"\u003e\n    \u003cimg width=\"300\" alt=\"pushover_iphone_example\" src=\"https://user-images.githubusercontent.com/3497137/136384645-843b8496-ad40-4c89-998b-ff46ea9f73a7.png\"\u003e\n    \u003cimg width=\"300\" alt=\"pushover_android_example\" src=\"https://user-images.githubusercontent.com/3497137/136384911-1759a502-b51b-4da2-bbe9-a0244c4de468.png\"\u003e\n\u003c/p\u003e\n\n_Image of slack notification via `ntfy + slack_webhook`_\n\n\u003cimg width=\"899\" alt=\"Screen Shot 2021-10-09 at 1 57 51 PM\" src=\"https://user-images.githubusercontent.com/3497137/136669318-4e93e062-be38-4881-b63e-b36f69547a0a.png\"\u003e\n\n## Quick demos and tutorials :notebook:\n\nTo test out this extension without any local set-up, please check out the [binder link](https://mybinder.org/v2/gh/mwakaba2/jupyterlab-notifications/main?urlpath=lab/tree/tutorial/py3_demo.ipynb). This will set-up the environment, install the extension, and take you to several demo notebooks for you to play around with to get familiar with the notifications extension.\n\nIn the `tutorial` directory, there are several example notebooks you can use to test out the notifications extension.\n\n- Notebooks with `py3_demo_` prefix - Minimal Python3 Notebooks to test out the extension.\n- `julia_demo.ipynb` - Minimal Julia Notebook to test out the extension. :warning: Note: The `tutorial/julia_demo.ipynb` will not work in the binder environment and will require additional set-up to test the Julia Notebook Kernel locally.\n\n## Compatible Versions and Requirements 🧰\n\n| `jupyterlab-notifications` | `jupyterlab` | `Notebook Cell Timing Enabled` | `Browser Requirements`              |\n| -------------------------- | ------------ | ------------------------------ | ----------------------------------- |\n| `\u003e=0.3.0`                  | `\u003e=3.1.0`    | Not required                   | Supports the Notification Web API\\* |\n| `\u003c0.3.0`                   | `\u003e3.0.0`     | Required                       | Supports the Notification Web API\\* |\n\n\\*For Notification Web API support, please check out [Browser Compatibility Chart](https://developer.mozilla.org/en-US/docs/Web/API/notification#browser_compatibility))\n\n## Install\n\nFor JupyterLab 3.x, the extension can be installed with `pip`:\n\n```bash\npip install jupyterlab-notifications\n```\n\nor `conda`:\n\n```bash\nconda install -c conda-forge jupyterlab-notifications\n```\n\n## Settings\n\nUse the following settings to update cell execution time for a notification and information to display in the notification. (in `Settings \u003e Advanced Settings Editor`):\n\n```json5\n{\n  // Notifications\n  // jupyterlab-notifications:plugin\n  // Settings for the Notifications extension\n  // ****************************************\n\n  // Cell Number Type\n  // Type of cell number to display when the report_cell_number is true. Select from 'cell_index' or ‘cell_execution_count'.\n  cell_number_type: 'cell_index',\n\n  // Enabled Status\n  // Enable the extension or not.\n  enabled: true,\n\n  // Trigger only for the last selected notebook cell execution.\n  // Trigger a notification only for the last selected executed notebook cell.\n  // NOTE: Only Available in version \u003e= v0.3.0\n  last_cell_only: false,\n\n  // Minimum Notebook Cell Execution Time\n  // The minimum execution time to send out notification for a particular notebook cell (in seconds).\n  minimum_cell_execution_time: 60,\n\n  // Notification Methods\n  // Option to send a notification with the specified method(s). The available options are 'browser' and 'ntfy'.\n  notification_methods: ['browser'],\n\n  // Report Notebook Cell Execution Time\n  // Display notebook cell execution time in the notification.\n  // If last_cell_only is set to true, the total duration of the selected cells will be displayed.\n  report_cell_execution_time: true,\n\n  // Report Notebook Cell Number\n  // Display notebook cell number in the notification.\n  report_cell_number: true\n}\n```\n\n![notification](https://user-images.githubusercontent.com/3497137/111881088-01db5200-897d-11eb-8faa-4701cabfcde4.gif)\n\n### How to enable Notebook Cell Timing\n\n:warning: For versions \u003c `0.3.0`, Notebook Cell Timing needs to be enabled for Jupyterlab Notifications to work. Please go to Settings -\u003e Advanced Settings Editor -\u003e Notebook and update setting to:\n\n```json5\n{\n  // Recording timing\n  // Should timing data be recorded in cell metadata\n  recordTiming: true\n}\n```\n\nThe cell timing doesn't need to be enabled for Jupyterlab \u003e= 3.1 and Jupyterlab notification version \u003e= v0.3.0.\n\n## (Optional) Notifications using `ntfy`\n\nYou can recieve notifications via `ntfy`.\n\n**ntfy 2.7.0 documentation** https://ntfy.readthedocs.io/en/latest/\n\n\u003e ntfy brings notification to your shell. It can automatically provide desktop notifications when long running code executions finish or it can send push notifications to your phone when a specific execution finishes.\n\n### How to enable notifications via `ntfy`\n\nInstall `ntfy`.\n\n```console\n$ pip install ntfy\n```\n\nYou can find configuration instructions for different operating systems in [the ntfy official configuration docs](https://ntfy.readthedocs.io/en/latest/#configuring-ntfy)\n\nFor example, if you want to get notifications via the [Pushover mobile app](https://pushover.net/), make sure to create the configuration file in the right location and select `pushover` for the backend.\n\n```console\n$ vim ~/.config/ntfy/ntfy.yml # Linux\n$ vim ~/Library/Application Support/ntfy/ntfy.yml # macOS\n```\n\n**Note:** You'll need to first install the Pushover mobile app and create an account to generate your user key.\n\n```yaml\nbackends:\n  - pushover\npushover:\n  user_key: YOUR_PUSHOVER_USER_KEY\n```\n\nChange the notifications [settings](#settings). Append `\"ntfy\"` into `notification_methods` attribute.\n\n- NOTE: The value `browser` implies default conventional method, which uses Webbrowser's Notification API.\n\n```json5\n{\n  // ...\n  notification_methods: ['browser', 'ntfy']\n  // ...\n}\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-notifications directory\n# Install package in development mode\npip install -e .\n# Link your development version of the extension with JupyterLab\njlpm run install:extension\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\n### Uninstall\n\n```bash\npip uninstall jupyterlab-notifications\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmwakaba2%2Fjupyterlab-notifications","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmwakaba2%2Fjupyterlab-notifications","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmwakaba2%2Fjupyterlab-notifications/lists"}