jupyternotify 0.1.15
A Jupyter Notebook %%magic for Browser Notifications of Cell Completion
License: BSD-3-Clause

|pypiv| |pyv| |License| |Thanks|

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>`__).

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:

.. code:: bash

    git clone git@github.com: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:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: 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:

.. code:: python

    import jupyternotify
    ip = get_ipython()
    ip.register_magics(jupyternotify.JupyterNotifyMagics(
        ip,
        option_name="option_value"
    ))

or add this to your ipython startup file:

.. code:: 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:

.. code:: 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.

.. code:: 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 <seconds>``
or ``%autonotify -a <seconds>``.

.. code:: python

    import numpy as np
    import time
    # autonotify on completion for cells that run longer than 30 seconds
    %autonotify -a 30

Then later...

.. code:: python

    # no notification
    time.sleep(29)

.. code:: 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``.

.. code:: python

    %%notify -o
    answer = 42
    'The answer is {}.'.format(answer)

Notification message: The answer is 42.

.. |pypiv| image:: https://img.shields.io/pypi/v/jupyternotify.svg
   :target: https://pypi.python.org/pypi/jupyternotify
.. |pyv| image:: https://img.shields.io/pypi/pyversions/jupyternotify.svg
   :target: https://pypi.python.org/pypi/jupyternotify
.. |License| image:: https://img.shields.io/pypi/l/jupyternotify.svg
   :target: https://github.com/ShopRunner/jupyter-notify/blob/master/LICENSE.txt
.. |Thanks| image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
   :target: https://saythanks.io/to/mdagost


| Michelangelo D'Agostino <mdagostino@shoprunner.com>, <mdagost@gmail.com>
| Nicole Carlson <ncarlson@shoprunner.com>, <nicole@parsingscience.com>
| Hanna Torrence <htorrence@shoprunner.com>, <hanna.torrence@gmail.com>
| 

License
-------
Copyright (c) 2017, ShopRunner

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.