Skip to main content

Personal notification and debug tool for multi-tasking software developers

Project description

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"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

meerkatio-1.12.tar.gz (63.6 kB view details)

Uploaded Source

Built Distribution

meerkatio-1.12-py3-none-any.whl (50.0 kB view details)

Uploaded Python 3

File details

Details for the file meerkatio-1.12.tar.gz.

File metadata

  • Download URL: meerkatio-1.12.tar.gz
  • Upload date:
  • Size: 63.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.4

File hashes

Hashes for meerkatio-1.12.tar.gz
Algorithm Hash digest
SHA256 fd6314e866f74827c2a5995ed114c8c10ea9cbf08f7bc5bbb7d2dab3b5a65a08
MD5 ee7c11ddf122ff4258f24bdd3ce17484
BLAKE2b-256 035e017eaa4e3dad5f4d636eb2f23b8bd1ec315ddc9960be18440276cb263467

See more details on using hashes here.

File details

Details for the file meerkatio-1.12-py3-none-any.whl.

File metadata

  • Download URL: meerkatio-1.12-py3-none-any.whl
  • Upload date:
  • Size: 50.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.4

File hashes

Hashes for meerkatio-1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 be7a0039659c7fa31b87744546e377d8a9707160b6a1f57a4e2729efd87b734c
MD5 37d2bc73d03b30d0be14c135a237fa1b
BLAKE2b-256 4035c8c81477458236d565a2a14b0484910f2adf10cc67d2d8f94b423ca5e2b2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page