Metadata-Version: 2.4
Name: wechat-ilink-sdk
Version: 0.1.0
Summary: Python SDK for WeChat iLink Bot protocol
Project-URL: Homepage, https://github.com/pengjingbo/wechat-ilink-python-sdk
Project-URL: Repository, https://github.com/pengjingbo/wechat-ilink-python-sdk
Project-URL: Issues, https://github.com/pengjingbo/wechat-ilink-python-sdk/issues
Author: pengjingbo
License: MIT License
        
        Copyright (c) 2026 pengjingbo
        
        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.
License-File: LICENSE
Keywords: ilink,python,sdk,wechat
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
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 :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: httpx>=0.27
Requires-Dist: pydantic>=2.0
Requires-Dist: qrcode>=8.0
Provides-Extra: dev
Requires-Dist: build>=1.2.2; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: respx>=0.22; extra == 'dev'
Requires-Dist: twine>=6.1.0; extra == 'dev'
Provides-Extra: release
Requires-Dist: build>=1.2.2; extra == 'release'
Requires-Dist: twine>=6.1.0; extra == 'release'
Description-Content-Type: text/markdown

# wechat-ilink-python-sdk

Python SDK for the WeChat iLink Bot protocol.

## Features

- QR-code login flow for iLink bot accounts
- Async HTTP client for iLink APIs
- Long-polling message loop and dispatch
- Local credential and state persistence
- Example echo bot for quick start

## Requirements

- Python 3.10+

## Installation

Install the published package from PyPI:

```bash
pip install wechat-ilink-sdk
```

## Quick Start

Import the public SDK entry points from the `ilink` package:

```python
from ilink import ILinkClient, login_with_qr

print(ILinkClient)
print(login_with_qr)
```

Run the bundled example from a cloned repository:

```bash
python example.py
```

On first run, the bot will ask for QR-code login and cache credentials locally.

## Main Modules

- `ilink.auth`: QR-code login flow
- `ilink.client`: async API client and polling loop
- `ilink.store`: local persistence for credentials and cursors
- `ilink.types`: protocol models and enums
- `ilink.utils`: helper utilities

## Development

Set up a local development environment with test dependencies:

```bash
uv sync --extra dev
```

Run the test suite through the installed package:

```bash
uv run pytest
```

Build release artifacts locally:

```bash
uv sync --extra release
uv run python -m build
uv run twine check dist/*
```

The manual PyPI release checklist lives in `docs/releasing.md`.
