Logging to Slack, made easy.
Project description
SlackPush - Logging to Slack made easy
SlackPush provides a wrapper on requests to push messages, logs, exceptions and attachments to slack. It also supports basic formating: Bold and Perforated.
Installation
To get started, clone the repository and run
pip install slackpush
Usage
- Import the SlackPush object.
from slackpush import SlackPush
- Initialise SlackPush object with a webhook_url and channel to be posted in. To know more about incoming webhooks read here.
slackpush = SlackPush(webhook_url= <your webhook_url>, channel=<your channel>)
- Push messages/ logs using
send_message
method.
slackpush.send_message('It is up and running')
- Similarly you can push specific exceptions as alerts to slack using
send_exception
method. This pushes the whole stack trace of the error to slack.
try:
< your code here>
except Exception as e:
slackpush.send_exception(e)
- To send attachments to slack, you need to pass Slack OAuth token. More details can be found here.
Note: See that the token has relevant persmissions to post the attachement
To add token to the object use add_token
method. To send an attachment to Slack:
slackpush.send_attachment(<path to attachment>)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
slackpush-0.1.1.tar.gz
(4.6 kB
view hashes)
Built Distribution
Close
Hashes for slackpush-0.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d5c183ace2483403b71eb687ea74ca2b92a337c25fdedec2808dc950fe382eb |
|
MD5 | 452065a891c37dd9f7380de28941ce98 |
|
BLAKE2b-256 | a158701e24a351731df0ed6d69c0bdd1bc5a7ec67f9465be59f68dc7c63dbcf2 |