Metadata-Version: 2.1
Name: wx-robot-client
Version: 1.0.1
Summary: Robot Client for QiYe Wechat
Home-page: https://github.com/suqingdong/wx_robot
Author: suqingdong
Author-email: suqingdong1114@gmail.com
License: MIT License
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: loguru
Requires-Dist: requests
Requires-Dist: python-dotenv

# Robot Client for QiYe Wechat
> https://developer.work.weixin.qq.com/document/14404


## Installation

```bash
python3 -m pip install wx-robot-client
```

## Usage

### Usage in CMD

```bash
wx_robot -h

# method 1: use -k option
wx_robot -k YOUR_ROBOT_KEY 'hello world'

# method 2: use env variable
WX_ROBOT_KEY=YOUR_ROBOT_KEY wx_robot 'hello world'

# method 3: use .env [recommend]
echo "WX_ROBOT_KEY=YOUR_ROBOT_KEY" > .env
wx_robot 'hello world'

# --------------------------------------------------

# send text
wx_robot 'hello world'

# send text with mentioned_list
wx_robot 'hello world' -m user1 -m user2
wx_robot 'hello world' -m @all

# send text with metioned_mobile_list   
wx_robot 'hello world' -M 13800138000 -M 13800138001
wx_robot 'hello world' -M @all

# send markdown
wx_robot -t markdown '# hello world'

# send image
wx_robot -t image test.png

# send file
wx_robot -t file README.md

# send news
wx_robot -t news '[{"title": "Hello, World!", "description": "...", "url": "https://www.example.com", "picurl": "xxx"}]'

# --------------------------------------------------
# send message from file
wx_robot requirement.txt
wx_robot -t markdown README.md
wx_robot -t news news.json
wx_robot -t template_card template_card.json
```

### Usage in Python

```python
from wx_robot.core import Robot

robot = Robot()

robot.send_text('Hello, World!')
robot.send_text('Hello, World!', mentioned_list=['user1', 'user2'])
robot.send_text('Hello, World!', mentioned_mobile_list=['13800138000', '13800138001'])
robot.send_markdown('# Hello, World!')
robot.send_image('test.png')
robot.send_file('README.md')

robot.send_news([{
    'title': 'Hello, World!',
    'description': 'This is a test news.',
    'url': 'https://www.example.com',
    'picurl': 'https://www.example.com/demo.png',
}])
```


