Metadata-Version: 2.4
Name: pywgb
Version: 0.0.2
Summary: Wecom(A.K.A. WeChat Work) Group Bot python API.
Author-email: Rex Zhou <879582094@qq.com>
License: MIT License
        
        Copyright (c) 2025 ChowRex
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/ChowRex/pywgb
Project-URL: Documentation, https://github.com/ChowRex/pywgb#readme
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.25.0
Dynamic: license-file

# pywgb
Wecom(A.K.A. WeChat Work) Group Bot python API.

## Homepage

> [ChowRex/pywgb: Wecom(A.K.A Wechat Work) Group Bot python API.](https://github.com/ChowRex/pywgb)

## How to use

1. Create a [Wecom Group Bot](https://qinglian.tencent.com/help/docs/2YhR-6/).
2. Copy the webhook URL or just the `key`. It should be like:

   - `Webhook`: *https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=UUID*
   - `Key`: *UUID*

3. Install this package: `pip install pywgb`
4. Refer code below:

   ```python
   from pywgb import TextWeComGroupBot, MarkdownWeComGroupBot, ImageWeComGroupBot
   
   KEY = "PASTE_YOUR_KEY_OR_WEBHOOKURL_HERE"
   
   # If you want to send Text message, use this.
   msg = "This is a test Text message."
   bot = TextWeComGroupBot(KEY)
   bot.send(msg)
   
   # If you want to send Markdown message, use this.
   msg = "# This is a test Markdown title message."
   bot = MarkdownWeComGroupBot(KEY)
   bot.send(msg)
   
   # If you want to send Image message, use this.
   file = "Path/To/Your/Image.png" or "Path/To/Your/Image.jpg"
   bot = ImageWeComGroupBot(KEY)
   bot.send(file_path=file)
   ```

## Official Docs

> Only Chinese version doc: [群机器人配置说明 - 文档 - 企业微信开发者中心](https://developer.work.weixin.qq.com/document/path/99110)

## Roadmap

- [x] v0.0.1: :tada: Initial project. Offering send Text and Markdown type message.

- [x] v0.0.2: :framed_picture: Add `Image` type message support;
  
  Add overheat detect function and unified exception handling
  
- [ ] v0.0.3: :newspaper: Add `News` type message support.

- [ ] v0.0.4: :open_file_folder: Add `File` type message support.

- [ ] v0.0.5: :speaking_head: Add `Voice` type message support.

- [ ] v0.0.6: :spiral_notepad: Add `TextCard` type message support.

- [ ] v0.0.7: :card_file_box: Add `PictureCard` type message support.

- [ ] v0.1.0: :thumbsup: First FULL capacity stable version release.Fix bugs and so on.

