index.rst

wxpy: 用 Python 玩微信

微信机器人 / 可能是最优雅的微信个人号 API

wxpy 在 itchat 的基础上，通过大量接口优化提升了模块的易用性，并进行丰富的功能扩展

Attention!

强烈建议仅使用小号运行机器人！

从近期 (17年6月下旬) 反馈来看，使用机器人存在一定概率被限制登录的可能性。

主要表现为无法登陆 Web 微信 (但不影响手机等其他平台)。

项目主页

https://github.com/youfou/wxpy

用来干啥

一些常见的场景

• 控制路由器、智能家居等具有开放接口的玩意儿
• 运行脚本时自动把日志发送到你的微信
• 加群主为好友，自动拉进群中
• 跨号或跨群转发消息
• 自动陪人聊天
• 逗人玩
• ...

总而言之，可用来实现各种微信个人号的自动化操作

轻松安装

wxpy 支持 Python 3.4-3.6，以及 2.7 版本

将下方命令中的 "pip" 替换为 "pip3" 或 "pip2"，可确保安装到对应的 Python 版本中

1. 从 PYPI 官方源下载安装 (在国内可能比较慢或不稳定):

pip install -U wxpy

2. 从豆瓣 PYPI 镜像源下载安装 (推荐国内用户选用):

pip install -U wxpy -i "https://pypi.doubanio.com/simple/"

简单上手

..  automodule:: wxpy

模块特色

• 全面对象化接口，调用更优雅

• 默认多线程响应消息，回复更快

• 包含 聊天机器人、共同好友 等 :doc:`实用组件 <utils>`

• 只需两行代码，在其他项目中 :doc:`用微信接收警告 <logging_with_wechat>`

• :doc:`愉快的探索和调试 <console>`，无需涂涂改改

• 可混合使用 itchat 的原接口

• 当然，还覆盖了各类常见基本功能:

  • 发送文本、图片、视频、文件
  • 通过关键词或用户属性搜索 好友、群聊、群成员等
  • 获取好友/群成员的昵称、备注、性别、地区等信息
  • 加好友，建群，邀请入群，移出群

更新日志

https://github.com/youfou/wxpy/releases

文档目录

..  toctree::
    :maxdepth: 2

    bot
    chats
    messages
    logging_with_wechat
    console
    utils
    response_error
    itchat
    faq