Jarjar Slack Notifier

Jarjar is a python utility that makes it easy to send slack notifications to your teams. You can import it as a python module or use our command line tool.

What can jarjar do for me?

Jarjar was developed at the Austerweil Lab at UW-Madison as a tool for scientists. We use it for all sorts of things, such as:

1. Sending a message so that we know when long-running processes have finished.

2. Sending notices when scheduled tasks have failed.

3. Sending out daily positive vibes.

Quickstart

Installation is simple!

pip install jarjar

For the bleeding edge:

pip install git+https://github.com/AusterweilLab/jarjar.git

My guess is that you'll want to create jarjar's config file, .jarjar. This tells jarjar what you'd like to use as a default for your slack team's webhook, the channel to post to, and the message it sends. Don't worry, you can over-ride these anytime.

Jarjar automatically looks for .jarjar in the current working directory as well as the user home (~), so edit this snippet and throw it one of those places:

channel='@username'
message='Custom message'
webhook='https://hooks.slack.com/services/your/teams/webhook'

If you don't know your team's webhook, you might have to make one.

Python API

Use the jarjar python api like:

from jarjar import jarjar

jj = jarjar() # defaults from .jarjar
jj.text('Hi!')

# send an attachment
jj.attach({'meesa': 'jarjar binks'}, message='Hello!')

Jarjar also supports decorator and Jupyter magic workflows!

Command Line Tool

We also made a command line tool for use outside of python scripts. The command line tool adds functionality to execute processes and send messages when they are complete.

jarjar sleep 1 -m 'Meesa took a nap!'

And then in your slack team:

Custom attachments are not supported in the CLT at this time, but everything else is:

jarjar -m 'Meesa jarjar binks!'
jarjar -m 'Hi, everyone!!' --webhook '<your-url>' -c '#general'

Documentation

We're on Read The Docs!

Having Trouble? Or a feature request?

We are terrible developers and you'll probably run into all sorts of problems. Don't be shy, file an issue on github!