Metadata-Version: 2.4
Name: qwsend
Version: 0.2.1
Summary: A lightweight WeCom (WeChat Work) webhook client using httpx with custom User-Agent
Author-email: Sam Song <samsong@stu.njau.edu.cn>
License-Expression: MIT
Project-URL: Homepage, https://github.com/ZhulongNT/qwsend
Project-URL: Issues, https://github.com/ZhulongNT/qwsend/issuesgi
Keywords: wecom,wechat-work,webhook,httpx
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Intended Audience :: Developers
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx<0.28,>=0.24
Provides-Extra: dev
Requires-Dist: pytest>=7; extra == "dev"
Dynamic: license-file

# qwsend

WeCom (企业微信) webhook client based on httpx with a clear, reusable API. It sets a custom User-Agent built from the project name and version.

- Sync and async clients
- Message types: text, markdown/markdown_v2, image, news, file, voice, template_card
- Media upload helper (file/voice)
- Simple CLI: `qwsend "hello" --key <key>`

## Install

```bash
pip install qwsend
```

## Quick start

CLI:

The CLI now uses subcommands to select the message type. Set the key either via `--key` or the environment variable `QWSEND_WEBHOOK_KEY`.

Examples (PowerShell):

```powershell
# preferred: supply key per-invocation (or set the env var once as shown below)
qwsend --key "<your_key>" text "hello from CLI"

# or set the environment variable for the session:
$env:QWSEND_WEBHOOK_KEY = "<your_key>"

# text with mentions (repeatable --mention)
qwsend text "hi everyone" --mention user1 --mention user2

# markdown (use --v2 for markdown_v2)
qwsend markdown "**bold** and _italic_" --v2

# send image from a local file (use -f / --file)
qwsend image -f .\path\to\image.jpg

# send news (JSON file containing an articles list)
qwsend news -f .\path\to\articles.json

# upload then send a file (CLI uploads then sends the file)
qwsend file -f .\path\to\file.pdf

# upload then send a voice file (CLI uploads then sends the voice)
qwsend voice -f .\path\to\audio.amr

# send template_card from a JSON file
qwsend template-card -f .\path\to\template.json
```

## markdown from file

You can also provide markdown content from a local file using `-f/--file`.
If both a positional content and `-f` are provided, the file content takes precedence.

PowerShell example:

```powershell
# read markdown from file and send
qwsend markdown -f .\path\to\message.md
```

Sync:

```python
from qwsend import WebhookClient

client = WebhookClient(key="<your_key>")
client.send_text("hello world")
client.send_markdown("**bold**")
client.close()
```

Async:

```python
import asyncio
from qwsend import AsyncWebhookClient

async def main():
    client = AsyncWebhookClient(key="<your_key>")
    await client.send_text("hello async")
    await client.aclose()

asyncio.run(main())
```

## User-Agent

The client uses a UA like: `qwsend/0.1.0 (+https://pypi.org/project/qwsend/)`.

## Tests

- Dry tests: run without network (recommended during development)
- Wet tests: live webhook calls — enabled when `QWSEND_WEBHOOK_KEY` is set in your environment. When that variable is set, running `pytest` will execute wet tests. There is no separate `-m wet` tag required now.

```bash
# run dry-only tests
pytest
# run all tests (will include wet/live tests if QWSEND_WEBHOOK_KEY is set)
export QWSEND_WEBHOOK_KEY="fakexxxx-7aoc-4bc4-97a0-0ec2sifa5aaa"
pytest
```

## Packaging

This project uses `pyproject.toml` with setuptools. Build and publish:

```bash
python -m build
python -m twine upload dist/*
```

## License

MIT
