A universal multiplatform message bot
Project description
omniunibot
🤖 An omnipotent universal message bot library for python
- Supported platforms
- Feishu
- Slack
- Dingtalk
- WeChat Work (WeCom)
- Features
- Non-blocking mode for sending messages
- Send to multiple platforms with one-line code
💻 Installation
- (via pip)
pip install -U omniunibot
- (via source) clone this repo &&
python setup.py install
orpython setup.py develop
📜 Usage
Standalone non-blocking mode
-
Prepare a config file
- Default config path:
$HOME/configs/omniunibot.json
- Config example
{ "channels": { "test-channels": [ { "platform": "feishu", "webhook": "https://open.feishu.cn/open-apis/bot/v2/hook/xxxxx-xxxxx", "secret": "xxxxx" }, { "platform": "slack", "webhook": "https://hooks.slack.com/services/xxxx/xxxx/xxxxxx" }, { "platform": "dingtalk", "webhook": "https://oapi.dingtalk.com/robot/send?access_token=xxxxx", "secret": "SECxxxxx" }, { "platform": "wecom", "webhook": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxx-xxxxx" } ] }, "bind": "tcp://*:58655" }
- Default config path:
-
Start the bot server
python -m omniunibot
-
Use the client-side code in your code
from omniunibot import OmniUniBotClient client = OmniUniBotClient("tcp://localhost:58655") client.send( channel="test-channels", title="msgTitle", msg="msgContent" )
Integration mode (Blocking mode, not recommended)
# import bots
from omniunibot import FeishuBot, DingTalkBot, WeComBot, SlackBot
# initialize bots
bot = FeishuBot('<webhook>', '<secret>')
bot = DingTalkBot('<webhook>', '<secret>')
bot = WeComBot('<webhook>')
bot = SlackBot('<webhook>')
# send message
bot.sendQuickMessage('Test Passed')
You could check the code example in ./example
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
omniunibot-0.0.5.tar.gz
(8.7 kB
view hashes)
Built Distribution
omniunibot-0.0.5-py3-none-any.whl
(11.3 kB
view hashes)
Close
Hashes for omniunibot-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6171d805ea505088c162d69764195568c6959452102bd07aa8157fc943803279 |
|
MD5 | d41b183998d0ebf165a9e419bf102862 |
|
BLAKE2b-256 | 6f9a75cb1dc0ff9703f9a145a8747e6d8a4a209e7799707f85b35a85825a137e |