MeerkatIO Python Package

Introduction

MeerkatIO is the personal notification platform for software developers and data scientists. Stop watching your code run and reclaim time in your day! Use this package to trigger personal notifications when your long running build or test processes finish, or to log output for personal debugging to an external communication channel.

Get started with just 2 lines of code!

Installation

$ pip3 install meerkatio

Authenticating

After creating an account at MeerkatIO you will be given a unique token which can be used to authenticate with the SDK. Your Meerkat token can either be set in your environment with the MEERKAT_TOKEN environmental variable or in the ~/.meerkat file in your user’s home directory. No authentication is required to use the free Ping feature of MeerkatIO.

Log In from the command line

$ meerkat login

Or manually set the MeerkatIO token

# Environmental Variable
$ export MEERKAT_TOKEN=token

# Cache File
$ echo "token" > ~/.meerkat

Code Examples

import meerkat

# Ping when script gets to checkpoint
meerkat.ping()

# Send a confirmation a function has run
output = build_model()
meerkat.email(output)

# Send Slack message to document model performance
perf = get_model_performance(output)
meerkat.slack(perf)

# Send SMS message when the script is finished
meerkat.sms("Script completed!")

Jupyter Notebook Example

import meerkat

# Ping when cell hits a debug checkpoint
%ping

# Send a confirmation that a cell has run
output = build_model()
%email output

# Send Slack message to document model performance
perf = get_model_performance(output)
%slack perf

# Send SMS message when the cell reaches the end
%sms "Cell completed!"

MeerkatIO Jupyter Notebook personal notification example alerting options

MeerkatIO CLI Tool

Access all of the same communication methods from your command prompt to integrate with any workflow.

$ meerkat ping
$ meerkat email "Bash script output: $1"
$ meerkat sms "Firmware build completed."
$ meerkat slack "Bash script complete"

Here is an example of how to use Meerkat with any script running from a terminal in order to ping youself when the script is finished running.

$ make build && meerkat email "Build succeeded" || meerkat sms "Build failed"

Release files for meerkatio 1.13

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for meerkatio 1.13
File	Size	Uploaded
meerkatio-1.13.tar.gz	63.6 kB	Apr 25, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for meerkatio 1.13
File	Interpreter	ABI	Platform	Reset
meerkatio-1.13-py3-none-any.whl 50.0 kB Apr 25, 2024	Python 3	none	any	Details

Total release size: 113.7 kB

Release files / meerkatio-1.13.tar.gz

Download URL	meerkatio-1.13.tar.gz
Size	63.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`42fef503b5d4ae6b30223739fe8c4161739ac3a4eab24dcbbf2236db8e5792dd`
BLAKE2b-256 checksum How to use checksums	`a3f5cf76905400eff34d0644408d5aeea31681c6367a40334af54ca72994f8c0`
Upload date	Apr 25, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.11.4`

Release files / meerkatio-1.13-py3-none-any.whl

Download URL	meerkatio-1.13-py3-none-any.whl
Size	50.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`e6439511a2886835a7a39d1b7e55c87403f1a1d1c9b12a4f464ce673132868a3`
BLAKE2b-256 checksum How to use checksums	`b9a822449177ed45bbff81101a316b8150133412771c084bae6bc79441d62b00`
Upload date	Apr 25, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.11.4`