slackpy
A Simple and Human Friendly Slack Client for Logging.
Use Case
Web Application
NEW! AWS Lambda
Bash Script
Install
pip install slackpy
Dependencies
requests
Sample Code
import slackpy
INCOMING_WEB_HOOK = 'your_web_hook_url'
CHANNEL = '#general'
USER_NAME = 'Logger'
ICON_URL = 'http://lorempixel.com/48/48'
# Create a new instance.
logging = slackpy.SlackLogger(INCOMING_WEB_HOOK, CHANNEL, USER_NAME, ICON_URL)
# You can set a log level. The default level is INFO.
logging.set_log_level(slackpy.LogLv.DEBUG) # Or logging.set_log_level(10)
## Minimum Parameter
## logging = slackpy.SlackLogger(INCOMING_WEB_HOOK)
# Simple Usage
logging.info('INFO Message')
# LogLevel's only required parameter is "message", all others are optional.
# LogLevel: DEBUG
logging.debug(message='DEBUG Message', title='DEBUG Title', fields='')
# LogLevel: INFO
logging.info(message='INFO Message', title='INFO Title', fields='')
# LogLevel: WARN
logging.warn(message='WARN Message', title='WARN Title', fields='')
# LogLevel: ERROR
logging.error(message='ERROR Message', title='ERROR Title', fields='')
# LogLevel: CUSTOM
logging.message(message='CUSTOM Message', title='CUSTOM Title', color='good',
fields=[{"title": "CUSTOM", "value": "test", "short": True}],
log_level=40)
# Title Link (New v2.1.0)
logging.info(message='INFO Message', title='slackpy Repository here',
title_link='https://github.com/iktakahiro/slackpy')
Method |
LogLevel |
Color |
|---|---|---|
debug() |
DEBUG (10) |
#03A9F4 (Light Blue) |
info() |
INFO (20) |
good (green) |
warn() |
WARNING (30) |
warning (orange) |
error() |
ERROR (40) |
danger (red) |
The definition of the log level is based on the standard library. (https://docs.python.org/3.4/library/logging.html#levels)
Command line
export SLACK_INCOMING_WEB_HOOK='your_web_hook_url'
# LogLevel: DEBUG
slackpy -c '#your_channel' -m 'DEBUG Message' -l 10
# LogLevel: INFO
slackpy -c '#your_channel' -m 'INFO Message' -l 20
# LogLevel: WARN
slackpy -c '#your_channel' -m 'WARN Message' -l 30
# LogLevel: ERROR
slackpy -c '#your_channel' -m 'ERROR Message' -l 40
# LogLevel: DEBUG (without specifying #channel)
slackpy -m 'DEBUG Message' -l 10
# LogLevel: INFO (with Message Title)
slackpy -c '#your_channel' -t 'INFO Message Title' -m 'INFO Message' -l 20
For AWS Lamdba
# First, pip install to top of project directory.
pip install slackpy -t .
# Second, archive your source code and dependency packages.
zip -r src.zip lambda_function.py slackpy enum requests
# Finally, upload src.zip
About Versioning
slackpy is following Semantic Versioning 2.0.0.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
slackpy-2.2.2.tar.gz
(4.9 kB
view details)
File details
Details for the file slackpy-2.2.2.tar.gz.
File metadata
- Download URL: slackpy-2.2.2.tar.gz
- Upload date:
- Size: 4.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ac190bf477afccf8c425a51294f0e0a1587af9ef1f587826668fb5bb70859a1f
|
|
| MD5 |
0608e64d1144f1dd28a93b674294637f
|
|
| BLAKE2b-256 |
20268f5b767cb949d2d8bec45a23ad3023ef7184046fe1fd91242b07cc079791
|