Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ShopRunner/jupyter-notify
A Jupyter Notebook magic for browser notifications of cell completion
https://github.com/ShopRunner/jupyter-notify
datascience
Last synced: about 2 months ago
JSON representation
A Jupyter Notebook magic for browser notifications of cell completion
- Host: GitHub
- URL: https://github.com/ShopRunner/jupyter-notify
- Owner: ShopRunner
- License: bsd-3-clause
- Created: 2017-06-01T14:08:55.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2022-08-09T17:30:42.000Z (about 2 years ago)
- Last Synced: 2024-07-25T17:14:54.096Z (2 months ago)
- Topics: datascience
- Language: Python
- Homepage:
- Size: 42 KB
- Stars: 580
- Watchers: 72
- Forks: 40
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-jupyter-resources - GitHub - 47% open · ⏱️ 27.04.2021): (Jupyter-magic拓展)
- -awesome-jupyter - ShopRunner/jupyter-notify - Cell magic for browser notification of cell completion. (Runtimes/Frontends)
README
[](https://pypi.python.org/pypi/jupyternotify)
[](https://pypi.python.org/pypi/jupyternotify)
[](https://github.com/ShopRunner/jupyter-notify/blob/main/LICENSE.txt)
[](https://saythanks.io/to/mdagost)
# A Jupyter Magic For Browser Notifications of Cell Completion
This package provides a Jupyter notebook cell magic `%%notify` that notifies the user upon completion of a potentially long-running cell via a browser push notification. Use cases include long-running machine learning models, grid searches, or Spark computations. This magic allows you to navigate away to other work (or even another Mac desktop entirely) and still get a notification when your cell completes. Clicking on the body of the notification will bring you directly to the browser window and tab with the notebook, even if you're on a different desktop (clicking the "Close" button in the notification will keep you where you are).
### Supported browsers
The extension has currently been tested in Chrome (Version: 58.0.3029) and Firefox (Version: 53.0.3).
**Note**: Firefox also makes an audible bell sound when the notification fires (the sound can be turned off in OS X as described [here](https://stackoverflow.com/questions/27491672/disable-default-alert-sound-for-firefox-web-notifications)).
**Note for Remote Servers**: This extension will work on remote servers as well. However, you'll need to have the jupyter notebook running on https. You can find instructions [here](https://jupyter-notebook.readthedocs.io/en/stable/public_server.html).
## Import the repo
To use the package, install it via pip directly:
```
pip install jupyternotify
```
or add it to the requirements.txt of your repo.
To install directly from source:
``` bash
git clone [email protected]:ShopRunner/jupyter-notify.git
cd jupyter-notify/
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
jupyter notebook
```
## Usage
### Load inside a Jupyter notebook:
``` python
%load_ext jupyternotify
```
### Automatically load in all notebooks
Add the following lines to your ipython startup file:
```
c.InteractiveShellApp.extensions = [
'jupyternotify'
]
```
The .ipython startup file can be generated with `ipython profile create [profilename]` and will create a configuration file at `~/.ipython/profile_[profilename]/ipython_config.py'`. Leaving [profilename] blank will create a default profile (see [this](http://ipython.org/ipython-doc/dev/config/intro.html) for more info).
To test the extension, try
```
%%notify
import time
time.sleep(5)
```
## Options
NOTE: Currently options cannot be used with `%load_ext` or the ipython startup file instructions above.
To load the magic with options, you should load it manually by doing the following:
```python
import jupyternotify
ip = get_ipython()
ip.register_magics(jupyternotify.JupyterNotifyMagics(
ip,
option_name="option_value"
))
```
or add this to your ipython startup file:
```python
c.InteractiveShellApp.exec_lines = [
'import jupyternotify',
'ip = get_ipython()',
'ip.register_magics(jupyternotify.JupyterNotifyMagics(ip, option_name="option_value"))'
]
```
The following options exist:
- `require_interaction` - Boolean, default False. When this is true,
notifications will remain on screen until dismissed. This feature is currently
only available in Google Chrome.
## Custom Message
You may specify what message you wish the notification to display:
```python
%%notify -m "sleep for 5 secs"
import time
time.sleep(5)
```
## Fire notification mid-cell
You may also fire a notification in the middle of a cell using line magic.
```python
import time
time.sleep(5)
%notify -m "slept for 5 seconds."
time.sleep(6)
%notify -m "slept for 6 seconds."
time.sleep(2)
```
## Automatically trigger notification after a certain cell execution time
Using the `autonotify` line magic, you can have notifications automatically trigger on **cell finish** if the execution time is longer than some threshold (in seconds) using `%autonotify --after ` or `%autonotify -a `.
```python
import numpy as np
import time
# autonotify on completion for cells that run longer than 30 seconds
%autonotify -a 30
```
Then later...
```python
# no notification
time.sleep(29)
```
```python
# sends notification on finish
time.sleep(31)
```
`autonotify` also takes the arguments `--message` / `-m` and `--output` / `-o`.
## Use cell output as message
You may use the last line of the cell's output as the notification message using `--output` or `-o`.
```python
%%notify -o
answer = 42
'The answer is {}.'.format(answer)
```
Notification message: The answer is 42.