# WxPusher
[](https://badge.fury.io/py/wxpusher)
[](https://pypi.python.org/pypi/wxpusher/)
[](https://pypi.python.org/pypi/wxpusher/)
[](https://pepy.tech/project/wxpusher)
WxPusher Python SDK.
*其他语言版本: [English](https://github.com/wxpusher/wxpusher-sdk-python/blob/master/README-en.md), [简体中文](https://github.com/wxpusher/wxpusher-sdk-python/blob/master/README.md).*
## 入门指南
### 安装
```shell
pip install -U wxpusher
```
### 使用
```python
from wxpusher import WxPusher
WxPusher.send_message('<content>',
uids=['<uids>'],
topic_ids=['<topic_ids>'],
token='<appToken>')
WxPusher.query_message('<messageId>')
WxPusher.create_qrcode('<extra>', '<validTime>', '<appToken>')
WxPusher.query_user('<page>', '<page_size>', '<appToken>')
```
## 运行测试
### 配置
运行测试需要配置好 `appToken` 和 `uids`。
首先，将 `wxpusher/tests/` 文件夹下的配置样例 `config.sample.py` 复制并命名为 `config.py`。
```shell
cd wxpusher/tests
cp config.sample.py config.py
```
然后，填写 `config.py` 中的相应信息。
### 启动测试
配置好后就可以使用 `tox` 来运行测试了。
```shell
tox
```
或者直接使用 `nose` 也可以
```shell
nosetests
```
## TODO
- [x] 基本架构并上传到 PyPI
- [x] 发送消息.
- [x] 查询消息.
- [x] 创建二维码.
- [x] 查询用户.
- [ ] 更完备的客户端验证.
- [ ] 命令行脚本.
- [ ] 更完善的文档.
- [ ] 更完备的单元测试.
## 贡献
- 通过 Github Issues 提交评论或建议。
- 直接提交 Pull Requests 必须没问题。
Raw data
{
"_id": null,
"home_page": "https://github.com/wxpusher/wxpusher-sdk-python",
"name": "wxpusher",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "wxpusher wechat weixin notification push-notification python-sdk",
"author": "Xuan (Sean) Hu",
"author_email": "i+wxpusher@huxuan.org",
"download_url": "https://files.pythonhosted.org/packages/c0/0c/dc71bb71819df155a87d51cd7b2243e39aa5245a868628745c9bc818bfe5/wxpusher-2.3.0.tar.gz",
"platform": null,
"description": "# WxPusher\n\n[](https://badge.fury.io/py/wxpusher)\n[](https://pypi.python.org/pypi/wxpusher/)\n[](https://pypi.python.org/pypi/wxpusher/)\n[](https://pepy.tech/project/wxpusher)\n\nWxPusher Python SDK.\n\n*\u5176\u4ed6\u8bed\u8a00\u7248\u672c: [English](https://github.com/wxpusher/wxpusher-sdk-python/blob/master/README-en.md), [\u7b80\u4f53\u4e2d\u6587](https://github.com/wxpusher/wxpusher-sdk-python/blob/master/README.md).*\n\n## \u5165\u95e8\u6307\u5357\n\n### \u5b89\u88c5\n\n```shell\npip install -U wxpusher\n```\n\n### \u4f7f\u7528\n\n```python\nfrom wxpusher import WxPusher\nWxPusher.send_message('<content>',\n uids=['<uids>'],\n topic_ids=['<topic_ids>'],\n token='<appToken>')\nWxPusher.query_message('<messageId>')\nWxPusher.create_qrcode('<extra>', '<validTime>', '<appToken>')\nWxPusher.query_user('<page>', '<page_size>', '<appToken>')\n```\n\n## \u8fd0\u884c\u6d4b\u8bd5\n\n### \u914d\u7f6e\n\n\u8fd0\u884c\u6d4b\u8bd5\u9700\u8981\u914d\u7f6e\u597d `appToken` \u548c `uids`\u3002\n\n\u9996\u5148\uff0c\u5c06 `wxpusher/tests/` \u6587\u4ef6\u5939\u4e0b\u7684\u914d\u7f6e\u6837\u4f8b `config.sample.py` \u590d\u5236\u5e76\u547d\u540d\u4e3a `config.py`\u3002\n\n```shell\ncd wxpusher/tests\ncp config.sample.py config.py\n```\n\n\u7136\u540e\uff0c\u586b\u5199 `config.py` \u4e2d\u7684\u76f8\u5e94\u4fe1\u606f\u3002\n\n### \u542f\u52a8\u6d4b\u8bd5\n\n\u914d\u7f6e\u597d\u540e\u5c31\u53ef\u4ee5\u4f7f\u7528 `tox` \u6765\u8fd0\u884c\u6d4b\u8bd5\u4e86\u3002\n\n```shell\ntox\n```\n\n\u6216\u8005\u76f4\u63a5\u4f7f\u7528 `nose` \u4e5f\u53ef\u4ee5\n\n```shell\nnosetests\n```\n\n## TODO\n\n- [x] \u57fa\u672c\u67b6\u6784\u5e76\u4e0a\u4f20\u5230 PyPI\n- [x] \u53d1\u9001\u6d88\u606f.\n- [x] \u67e5\u8be2\u6d88\u606f.\n- [x] \u521b\u5efa\u4e8c\u7ef4\u7801.\n- [x] \u67e5\u8be2\u7528\u6237.\n- [ ] \u66f4\u5b8c\u5907\u7684\u5ba2\u6237\u7aef\u9a8c\u8bc1.\n- [ ] \u547d\u4ee4\u884c\u811a\u672c.\n- [ ] \u66f4\u5b8c\u5584\u7684\u6587\u6863.\n- [ ] \u66f4\u5b8c\u5907\u7684\u5355\u5143\u6d4b\u8bd5.\n\n## \u8d21\u732e\n\n- \u901a\u8fc7 Github Issues \u63d0\u4ea4\u8bc4\u8bba\u6216\u5efa\u8bae\u3002\n- \u76f4\u63a5\u63d0\u4ea4 Pull Requests \u5fc5\u987b\u6ca1\u95ee\u9898\u3002\n\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "WxPusher Python SDK.",
"version": "2.3.0",
"project_urls": {
"Homepage": "https://github.com/wxpusher/wxpusher-sdk-python"
},
"split_keywords": [
"wxpusher",
"wechat",
"weixin",
"notification",
"push-notification",
"python-sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1bf1b29bbe246dbd8a1fd14b73c384f477c46c3ee150b1eb8502276b5d2f8af7",
"md5": "4bab4317be6cf291e670b6fd492e8d9a",
"sha256": "c5a9a3c9dc3b605c2dfed985d680cb24d28674ccf5b2c2745218d79598db49fb"
},
"downloads": -1,
"filename": "wxpusher-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4bab4317be6cf291e670b6fd492e8d9a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 11298,
"upload_time": "2024-07-08T08:54:01",
"upload_time_iso_8601": "2024-07-08T08:54:01.702940Z",
"url": "https://files.pythonhosted.org/packages/1b/f1/b29bbe246dbd8a1fd14b73c384f477c46c3ee150b1eb8502276b5d2f8af7/wxpusher-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c00cdc71bb71819df155a87d51cd7b2243e39aa5245a868628745c9bc818bfe5",
"md5": "a9c44b3dd187183fda7b204d3dacd46d",
"sha256": "bc6eb319cfcfc8c9694914cf03a951c6fffc464ab8b90bc4a575c8ce26b17d00"
},
"downloads": -1,
"filename": "wxpusher-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "a9c44b3dd187183fda7b204d3dacd46d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 11978,
"upload_time": "2024-07-08T08:54:14",
"upload_time_iso_8601": "2024-07-08T08:54:14.534849Z",
"url": "https://files.pythonhosted.org/packages/c0/0c/dc71bb71819df155a87d51cd7b2243e39aa5245a868628745c9bc818bfe5/wxpusher-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-08 08:54:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wxpusher",
"github_project": "wxpusher-sdk-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "wxpusher"
}
JSON
