Skip to content

README.md

Latest commit

 

History

History
72 lines (49 loc) · 2.41 KB

README.md

File metadata and controls

72 lines (49 loc) · 2.41 KB

onepush

A Python library to send notifications to your iPhone, Discord, Telegram, WeChat, QQ and DingTalk.

Supported providers

Bark, Discord, Telegram, ServerChan, ServerChanTurbo, WechatWorkApp, WechatWorkBot, pushplus, go-cqhttp, Qmsg, DingTalk, Lark, SMTP, Customised providers

Installation

Via pip:

pip install onepush

Or via source code:

git clone https://github.com/y1ndan/onepush.git
cd onepush
python setup.py install

Basic Usage

from onepush import get_notifier

n = get_notifier('bark')
print(n.params)

response = n.notify(device_key='YOUR_BARK_KEY', title='OnePush', content='Hello World!')
print(response.text)

# {'required': ['device_key'], 'optional': ['title', 'subtitle', 'body', 'markdown', 'device_key', 'device_keys', 'level', 'volume', 'badge', 'call', 'autoCopy', 'copy', 'sound', 'icon', 'image', 'group', 'ciphertext', 'isArchive', 'url', 'action', 'id', 'delete', 'cipherkey', 'ciphermethod', 'base_url', 'content', 'key']}
# {"code":200,"message":"success","timestamp":1633528319}

Or:

from onepush import notify

notify('bark', device_key='YOUR_BARK_KEY', title='OnePush', content='Hello World!')

You can also use the alias key for device_key:

notify('bark', key='YOUR_BARK_KEY', title='OnePush', content='Hello World!')

Proxy Support

You can use proxy with any notifier by adding the proxies parameter:

# Using HTTP/HTTPS proxy
proxies = {
    'http': 'http://127.0.0.1:7890',
    'https': 'socks5h://127.0.0.1:7890'
}

notify('bark', 
       device_key='YOUR_BARK_KEY', 
       title='OnePush', 
       content='Hello World!',
       proxies=proxies)

The proxies parameter accepts the same format as the requests library.