Github:

https://github.com/somniumism/bwa

Document(English ver):

Bwa: Simple Notification Sender

👀 개요

bwa는 데코레이터를 통해 간단하게 알림을 보낼 수 있는 툴입니다. 여러분이 만든 함수 위에 deco_noti()와 몇 가지의 클라이언트 설정만 해주면, 함수가 시작되거나 끝나거나 혹은 예기치 못한 에러로 인해 종료되었을 때, 클라이언트로부터 알림을 받을 수 있습니다. 현재 디스코드, 슬랙,  텔레그램 그리고 Gmail을 통해 알림을 받을 수 있습니다.

가령 환경 변수로 webhook url 주소를 설정한다면, 다음과 같이 아주 간단하게 알림을 받을 수 있습니다.

from bwa.discord import deco_noti

@deco_noti()
def run():
    print("Hi, bwa!")

또한 bwa에서 제공하는 send_noti 메소드를 통해 원하는 곳에서 언제든지 지정한 webhook , e-mail 혹은 bot 으로 알림을 보낼 수 있습니다.

from bwa.slack import send_noti

def run():
		print("Start")
		send_noti(custom_content="Start")
		print("End")
		send_noti(custom_content="End")

만약 함수가 실행 중에 예기치 못한 경우로 종료되었다면, 종료된 시간과 런타임, 에러 정보에 대해서 아래와 같은 포맷으로 알림을 보내줍니다.

😭 Your function <function_name> ended unexpectedly due to an exception or error.
    - function name: function_name
    - start time: 2020-10-25 01:25:06
    - dead time: 2020-10-25 01:25:12
    - run time: 0:00:05.774958
    - Error Info:

    - Traceback:
    Traceback (most recent call last):
    File "/Users/test-user/test/gmail_test_case.py", line 83, in wrapper

🔨 설치

pip 를 통해 설치할 수 있습니다. 아래의 커맨드를 통해 설치를 해주시면 됩니다.

$ pip install bwa