Metadata-Version: 2.1
Name: slack-magic
Version: 0.0.3
Summary: Notify yourself via slack when lines or cells finish or error out.
Home-page: https://github.com/evanr70/slack_magic
Author: Evan
Author-email: evan.roberts@kellogg.ox.ac.uk
License: mit
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Framework :: IPython
Description-Content-Type: text/x-rst; charset=UTF-8
Requires-Dist: ipython
Provides-Extra: testing
Requires-Dist: pytest ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'

===========
slack_magic
===========


`slack_magic` defines an IPython magic function to send notifications to a slack app when a process completes or fails.


Description
===========

Install using `pip install slack_magic`

Load the extension within Jupyter or IPython `%load_ext slack_magic`

The first time you run `%notify` it will ask for your slack app webhook url. After that it will be stored in `~/.slack_magic`.

Use the magic as either a cell or a line magic:

.. code-block:: python

   %load_ext slack_magic

   # Send a confirmation that a line has run
   %notify "Nothing wrong with this code"

   # Send traceback to slack when an error is raised
   %notify 1 / 0

   # Send a confirmation that a cell has run
   %%notify
   "Nothing wrong with this code either"
   a = 10
   b = 144

   # Send traceback to slack when an error is raised in the cell
   %%notify
   "This won't fail"
   "But the next line will"
   1 / 0



