Skip to content

Commit

Permalink
Updateds the README.rst for PyPI. (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
mdagost authored Jan 8, 2018
1 parent 1ebb4a1 commit adee5bc
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,7 @@ Load inside a Jupyter notebook:

.. code:: python
import jupyternotify
ip = get_ipython()
ip.register_magics(jupyternotify.JupyterNotifyMagics)
%load_ext jupyternotify
Automatically load in all notebooks
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -65,10 +63,8 @@ Add the following lines to your ipython startup file:

::

c.InteractiveShellApp.exec_lines = [
'import jupyternotify',
'ip = get_ipython()',
'ip.register_magics(jupyternotify.JupyterNotifyMagics)'
c.InteractiveShellApp.extensions = [
'jupyternotify'
]

The .ipython startup file can be generated with
Expand All @@ -89,7 +85,11 @@ To test the extension, try
Options
-------

You may specify options while loading the magic:
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
Expand All @@ -100,6 +100,16 @@ You may specify options while loading the magic:
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
Expand Down

0 comments on commit adee5bc

Please sign in to comment.