Skip to main content

Simple notification tool for multi-tasking developers

Project description

MeerkatIO Documentation

Introduction

Welcome to the MeerkatIO documentation. MeerkatIO is a powerful command line interface (CLI) and Python module designed to help developers step away from their computer while their code is running.

Meerkat Python SDK

Installation

# PyPi
$ 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.

# Environment
$ export MEERKAT_TOKEN=token

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

Code Example

import meerkat

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

# Send a confirmation a function has run
output = build_model()
meerkat.email(f"""
	Send a multi-line email with the output of a function:
	{output}
""")

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

Jupyter Notebook Example

%load_ext meerkat

# Ping when cell hits a debug checkpoint
%ping

# Send a confirmation that a cell has run
output = build_model()
%email f"""
	Send a multi-line email with the output of a function:
	{output}
"""

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

MeerkatIO CLI Tool

Installation

# PyPi
$ pip3 install meerkatio

Authenticating

After creating an account at MeerkatIO you can use the same account credentials to authenticate the CLI, giving you access to the full suite of MeerkatIO services. No authentication is required to use the free Ping feature of MeerkatIO.

$ meerkat login

CLI Examples

All users have access to the ping alert feature which will generate a sound when the below command is run.

$ meerkat ping
$ meerkat email "Bash script output: $1"
$ meerkat sms "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.9.tar.gz (63.2 kB view details)

Uploaded Source

Built Distribution

meerkatio-1.9-py3-none-any.whl (49.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for meerkatio-1.9.tar.gz
Algorithm Hash digest
SHA256 2571d255cb0eb48a27065eb2f536e03b9f9948b54afdadb7f57c61a7c5147e1b
MD5 3398d571f8f4ba43b53f62783f029153
BLAKE2b-256 024a5748f5d36887df5b8fec7273a9e74215ee90bb6fca85518af3e2eef28f76

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meerkatio-1.9-py3-none-any.whl
  • Upload date:
  • Size: 49.7 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 1c4dcfa7f34110de9b24de44ad74dc09e977a66a97fe8751e29e76446a235ad6
MD5 28f9f482cb4ef934d0a571030c11a608
BLAKE2b-256 fe4188ca8fd3296a56696a82bee6fa391927db84b775c7955a29e5bf19c3d12d

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