Skip to content

zrn-fight/wechaty-puppet-walnut

 
 

Repository files navigation

PUPPET-WALNUT

NPM Version npm (tag) NPM

Powered by Wechaty TypeScript

运行方法

安装依赖

将代码clone到本地,执行npm install

在硬核桃5G消息开发者社区平台申请权限

在5G消息开发者社区平台,申请Chatbot应用调测工具5G消息开发者社区平台

配置系统环境变量

  1. WECHATY_PUPPET_WALNUT_APPID: Chatbot的AppId

  2. WECHATY_PUPPET_WALNUT_APPKEY:Chatbot的AppKey

  3. WECHATY_PUPPET_WALNUT_SIPID: Chatbot的sipId

运行示例代码

npm start

Learn more for building your first Wechaty bot at https://github.com/wechaty/

项目介绍

“开源软件供应链点亮计划-暑期2021”(以下简称 暑期2021)是由中科院软件所与 openEuler 社区共同举办的一项面向高校学生的暑期活动,旨在鼓励在校学生积极参与开源软件的开发维护,促进国内优秀开源软件社区的蓬勃发展。

根据项目的难易程度和完成情况,参与者还可获取“开源软件供应链点亮计划-暑期2021”活动奖金和奖杯。

官网:https://summer.iscas.ac.cn

Wechaty

Wechaty 是一个开源聊天机器人框架SDK,具有高度封装、高可用的特性,支持NodeJs, Python, Go 和Java 等多语言版本。在过去的5年中,服务了数万名开发者,收获了 Github 的 9600 Star。同时配置了完整的DevOps体系并持续按照Apache 的方式管理技术社区。

项目名称

开发支持电信运营商 5G Chatbot / RCS 的 Wechaty 接入 Puppet 模块

背景介绍

Wechaty 社区目前已经支持微信、Whatsapp、企业微信、飞书等常见流行即时通讯工具,并且能够通过多语言 SDK (比如 Python Wechaty) 进行调用。

5G Chatbot (RCS) 是近期中国电信运营商基于 5G 的消息战略落地平台,未来的 5G 手机将会内置 RCS 消息的处理能力。我们在本次 Summer 2021 的项目中,Wechaty 希望可以实现对RCS Chatbot 的支持。可以将 RCS 协议封装成为 wechaty-puppet-walnut 供 Wechaty 开发者方便接入 RCS 平台,使其成为 Wechaty 可以使用的社区生态模块。

需求介绍

使用 https://github.com/wechaty/wechaty-puppet-official-account 项目作为模版,将核心代码文件 https://github.com/wechaty/wechaty-puppet-official-account/blob/master/src/puppet-oa.ts 中的微信公众平台调用,全部替换(封装)为 RCS 模块的调用。

这里有一个专门讲解如何开发 Wechaty Puppet Provider 的 workshop 视频,它以 wechaty-puppet-official-account 作为例子,做了从0到1的入门讲解:Wechaty Workshop for Puppet Makers: How to make a Puppet for Wechaty。通过观看这一个小时的视频,应该可以系统性的了解如何完成构建一个 Wechaty Puppet Provider 模块。

在初期开发中,能够实现文本消息的接收和发送,即可完成原型验证 POC 。

还可以参考以下链接:

  1. TypeScript Puppet Official Documentation: https://wechaty.github.io/wechaty-puppet/typedoc/classes/puppet.html
  2. Wechaty Puppet Specification: https://wechaty.js.org/docs/specs/puppet
  3. https://github.com/wechaty/wechaty-puppet-mock

导师联系方式

  1. 李佳芮: Wechaty co-creator, Founder & CEO of Juzi.BOT ([email protected])
  2. 康嘉: 硬核桃社区https://www.5g-msg.com/ PM
  3. 李卓桓:Wechaty creator, Tencent TVP of Chatbot ([email protected])

项目产出目标

  1. 每日代码 commit
  2. 每周提交一份 report (回复本 issue)
  3. 每两周一次在线会议
  4. 发布 Git Repo wechaty-puppet-walnut
  5. 可以通过 Wechaty 加载 wechaty-puppet-walnut 模块,并通过 5G Chatbot / RCS 底层,实现文本消息的收发功能
  6. 提供一个 examples/ding-dong-bot.ts ,完成“接收到文字消息ding时,自动回复消息dong"的功能
  7. 配置 GitHub Actions 实现自动化测试* (可选)

项目技术栈

  1. TypeScript programming language
  2. Git
  3. REST API
  4. 5G Chatbot / Rich Communication Service
  5. 硬核桃社区 5G Chatbot SDK https://www.5g-msg.com/#/bussinessInformation

Links

相关链接

v0.0.1 (Jun 27, 2018)

Initial version.

Maintainer

COPYRIGHT & LICENSE

  • Code & Docs © 2018 Huan LI <[email protected]>
  • Code released under the Apache-2.0 License
  • Docs released under Creative Commons

About

Wechaty Puppet Walnut - 硬核桃5G消息

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 90.3%
  • Shell 6.4%
  • JavaScript 3.3%