Wechaty is a Conversational SDK for Chatbot Makers that can help you create a bot in 9 lines of Python.
"Wechaty is a great solution, I believe there would be much more users recognize it." link
— @Gcaufy, Tencent Engineer, Author of WePY"太好用，好用的想哭"
— @xinbenlv, Google Engineer, Founder of HaoShiYou.org"最好的微信开发库" link
— @Jarvis, Baidu Engineer"Wechaty让运营人员更多的时间思考如何进行活动策划、留存用户，商业变现" link
— @lijiarui, Founder & CEO of Juzi.BOT."If you know js ... try Wechaty, it's easy to use."
— @Urinx Uri Lee, Author of WeixinBot(Python)
See more at Wiki:Voice Of Developer
Wechaty is used in many ChatBot projects by thousands of developers. If you want to talk with other developers, just scan the following QR Code in WeChat with secret code python wechaty, join our Wechaty Python Developers' Home.
Scan now, because other Wechaty Python developers want to talk with you too! (secret code: python wechaty)
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.js.org/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())We already have Wechaty in TypeScript, It will be not too hard to translate the TypeScript(TS) to Python(PY) because wechaty has only 3,000 lines of the TS code, they are well designed and de-coupled by the wechaty-puppet abstraction. So after we have translated those 3,000 lines of TypeScript code, we will almost be done.
As we have already a ecosystem of Wechaty in TypeScript, so we will not have to implement everything in Python, especially, in the Feb 2020, we have finished the wechaty-grpc service abstracting module with the wechaty-puppet-service implmentation.
The following diagram shows out that we can reuse almost everything in TypeScript, and what we need to do is only the block located at the top right of the diagram: Wechaty (Python).
+--------------------------+ +--------------------------+
| | | |
| Wechaty (TypeScript) | | Wechaty (Python) |
| | | |
+--------------------------+ +--------------------------+
+-------------------------------------------------------+
| Wechaty Puppet Service |
| |
| (wechaty-puppet-service) |
+-------------------------------------------------------+
+--------------------- wechaty-grpc ----------------------+
+-------------------------------------------------------+
| Wechaty Puppet Abstract |
| |
| (wechaty-puppet) |
+-------------------------------------------------------+
+--------------------------+ +--------------------------+
| Pad Protocol | | Web Protocol |
| | | |
| wechaty-puppet-padplus | |(wechaty-puppet-puppeteer)|
+--------------------------+ +--------------------------+
+--------------------------+ +--------------------------+
| Windows Protocol | | Mac Protocol |
| | | |
| (wechaty-puppet-windows) | | (wechaty-puppet-macpro) |
+--------------------------+ +--------------------------+
There's a 100 lines class named Image in charge of downloading the WeChat image to different sizes.
It is a great example for demonstrating how do we translate the TypeScript to Python in Wechaty Way:
- TypeScript: https://github.com/wechaty/wechaty/blob/master/src/user/image.ts
- Python: https://github.com/wechaty/python-wechaty/blob/master/src/wechaty/user/image.py
If you are interested in the translation and want to look at how it works, it will be a good start from reading and comparing those two Image class files in TypeScript and Python at the same time.
- TS: TypeScript
- SLOC: Source Lines Of Code
- Class Wechaty @wj-mCat
- TS SLOC(1160): https://github.com/wechaty/wechaty/blob/master/src/wechaty.ts
- Code
- Unit Tests
- Documentation
- Class Contact
- TS SLOC(804): https://github.com/wechaty/wechaty/blob/master/src/user/contact.ts
- Code
- Unit Tests
- Documentation
- Class ContactSelf
- TS SLOC(199): https://github.com/wechaty/wechaty/blob/master/src/user/contact-self.ts
- Code
- Unit Tests
- Documentation
- Class Message
- TS SLOC(1054): https://github.com/wechaty/wechaty/blob/master/src/user/message.ts
- Code
- Unit Tests
- Documentation
- Class Room
- TS SLOC(1194): https://github.com/wechaty/wechaty/blob/master/src/user/room.ts
- Code
- Unit Tests
- Documentation
- Class Image @wj-mCat
- TS SLOC(60): https://github.com/wechaty/wechaty/blob/master/src/user/image.ts
- Code
- Unit Tests
- Documentation
- Class Accessory @huan
- TS SLOC(179): https://github.com/wechaty/wechaty/blob/master/src/accessory.ts
- Code
- Unit Tests
- Documentation
- Class Config @wj-mCat
- TS SLOC(187): https://github.com/wechaty/wechaty/blob/master/src/config.ts
- Code
- Unit Tests
- Documentation
- Class Favorite
- TS SLOC(52): https://github.com/wechaty/wechaty/blob/master/src/user/favorite.ts
- Code
- Unit Tests
- Documentation
- Class Friendship
- TS SLOC(417): https://github.com/wechaty/wechaty/blob/master/src/user/friendship.ts
- Code
- Unit Tests
- Documentation
- Class MiniProgram
- TS SLOC(70): https://github.com/wechaty/wechaty/blob/master/src/user/mini-program.ts
- Code
- Unit Tests
- Documentation
- Class RoomInvitation
- TS SLOC(317): https://github.com/wechaty/wechaty/blob/master/src/user/room-invitation.ts
- Code
- Unit Tests
- Documentation
- Class Tag
- TS SLOC(190): https://github.com/wechaty/wechaty/blob/master/src/user/tag.ts
- Code
- Unit Tests
- Documentation
- Class UrlLink
- TS SLOC(107): https://github.com/wechaty/wechaty/blob/master/src/user/url-link.ts
- Code
- Unit Tests
- Documentation
- Class FileBox
- TS SLOC(638): https://github.com/huan/file-box/blob/master/src/file-box.ts
- Code
- Unit Tests
- Documentation
- Class MemoryCard
- TS SLOC(376): https://github.com/huan/memory-card/blob/master/src/memory-card.ts
- Code
- Unit Tests
- Documentation
- Class WechatyPuppet
- TS SLOC(1115): https://github.com/wechaty/wechaty-puppet/blob/master/src/puppet.ts
- Code
- Unit Tests
- Documentation
- Class WechatyPuppetHostie
WIP...
- Python 3.7+
pip3 install wechatyPython Wechaty Scala Wechaty BETA Released!
Read more from our Multi-language Wechaty Beta Release event from our blog:
Welcome @huangaszaq for joining the project! #42
- Add a friendly exception message for PyPI users. #24
Welcome @wj-Mcat for joining the project! #4
- Starting translate TypeScript of Wechaty to Python
- DevOps Setup
- Type Checking: mypy & pytype
- Unit Testing: pytest
- Linting: pylint, pycodestyle, and flake8
- CI/CD: GitHub Actions
- Publish to PyPI automatically after the tests passed.
Project created, publish a empty module wechaty on PyPI.
- Wechaty - Conversatioanl AI Chatot SDK for Wechaty Individual Accounts (TypeScript)
- Python Wechaty - Python WeChaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Python)
- Go Wechaty - Go WeChaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Go)
- Java Wechaty - Java WeChaty Conversational AI Chatbot SDK for Wechat Individual Accounts (Java)
- Scala Wechaty - Scala WeChaty Conversational AI Chatbot SDK for WechatyIndividual Accounts (Scala)
[](https://github.com/wechaty/python-wechaty)
- @huangaszaq - Chunhong HUANG (黄纯洪)
- @wj-Mcat - Jingjing WU (吴京京)
- @huan - (李卓桓) zixia@zixia.net
- Code & Docs © 2018 Wechaty Contributors https://github.com/wechaty
- Code released under the Apache-2.0 License
- Docs released under Creative Commons