Python Wechaty 入门项目技术文档

Python Wechaty 入门项目技术文档

python-wechaty-getting-started Python Wechaty Starter Project Template that Works Out-of-the-Box 项目地址: https://gitcode.com/gh_mirrors/py/python-wechaty-getting-started

安装指南

环境要求

• Python 3.7 或更高版本

安装步骤

1. 克隆项目仓库

   git clone https://github.com/wechaty/python-wechaty-getting-started
   cd python-wechaty-getting-started
   

2. 安装依赖

   make install
   # 或者
   pip install -r requirements.txt
   

3. 设置机器人令牌 你需要一个 Wechaty Puppet Service 令牌。你可以从官方文档中学习如何获取它。

   export WECHATY_PUPPET=wechaty-puppet-service
   export WECHATY_PUPPET_SERVICE_TOKEN=your_token_at_here
   

   或者你可以使用 TOKEN 或 token 环境变量别名来设置令牌：

   export TOKEN=your_token_at_here
   # 或者
   export token=your_token_at_here
   

4. 运行机器人

   make bot
   # 或者
   python examples/ding-dong-bot.py
   

项目使用说明

快速开始

项目提供了一个简单的示例，展示了如何使用 Python Wechaty 创建一个基本的聊天机器人。你可以通过以下步骤快速启动一个机器人：

1. 设置环境变量：确保你已经设置了 WECHATY_PUPPET 和 WECHATY_PUPPET_SERVICE_TOKEN 环境变量。

2. 运行示例代码：

   python examples/ding-dong-bot.py
   

代码示例

以下是一个最简单的 Python Wechaty 聊天机器人示例，仅用 9 行代码即可实现：

from wechaty import Wechaty
import asyncio

async def main():
    bot = Wechaty()
    bot.on('scan', lambda status, qrcode, data: print('Scan QR Code to login: {}\nhttps://wechaty.wechaty.js/qrcode/{}'.format(status, qrcode)))
    bot.on('login', lambda user: print('User {} logged in'.format(user)))
    bot.on('message', lambda message: print('Message: {}'.format(message)))
    await bot.start()

asyncio.run(main())

项目API使用文档

Wechaty 类

• Wechaty(): 初始化一个 Wechaty 实例。
• on(event, callback): 监听特定事件并执行回调函数。
  • event: 事件名称，如 'scan', 'login', 'message' 等。
  • callback: 事件触发时执行的回调函数。
• start(): 启动 Wechaty 机器人。

事件类型

• scan: 当需要扫描二维码登录时触发。
• login: 当用户登录成功时触发。
• message: 当接收到消息时触发。

项目安装方式

通过 Git 安装

git clone https://github.com/wechaty/python-wechaty-getting-started
cd python-wechaty-getting-started
make install

通过 pip 安装

pip install wechaty

设置环境变量

export WECHATY_PUPPET=wechaty-puppet-service
export WECHATY_PUPPET_SERVICE_TOKEN=your_token_at_here

运行机器人

python examples/ding-dong-bot.py

通过以上步骤，你可以轻松地安装并运行 Python Wechaty 项目，开始构建你的聊天机器人。

python-wechaty-getting-started Python Wechaty Starter Project Template that Works Out-of-the-Box 项目地址: https://gitcode.com/gh_mirrors/py/python-wechaty-getting-started