vme 0.0.3

WeChat Work Message Bot.

Python API for WeChat Work Message Bot

企业微信群机器人 Python 接口和命令行工具。

About the name: v = WeChat, me = Me, vme = WeChat Me. It's somewhat inspired by Chinese Internet meme "VME50".

vme is listed on PyPI.

vme is dependency-free.

Python API

vme.send() sends text (str) or image (bytes). Due to limitations of WeChat Work, only PNG and JPG images under 2M size are allowed. Image is recognized by detecting first few bytes (magic bits) of the binary data. An exception will be raised if payload is neither text nor image.

All texts are sent as markdown. Please note that the markdown features WeChat Work supports are extremely limited.

vme.send_file() is not implemented yet.

import vme

# send text
vme.send('your-bot-key', 'Texts with `minimal markdown` support.')

# send image, only PNG or JPG are supported
image = plot_some_curve(...)
vme.send('your-bot-key', image)

# send file (NOT implemented yet)
vme.send_file('your-bot-key', '/path/to/your/file')

Command Line Tool

vme is runnable with python3 -m vme command line.

Send text or image

Text or image data can only be read through pipe or input redirection:

# sending texts from another process
echo "hello world" | python3.8 -m vme your-bot-key

# sending an image from file
python3.8 -m vme your-bot-key < plot.png

# sending long texts in a file
python3.8 -m vme your-bot-key < message.txt

# sending image from another process
my-plot --stdout ... | python3.8 -m vme your-bot-key

Send file

Althrough the API is still not implemented yet, command line semantic for "send this file as a file" is designed.

# sending a file
python3.8 -m vme your-bot-key /path/to/your/file