Skip to content

Latest commit

 

History

History
169 lines (111 loc) · 6.19 KB

README_EN.md

File metadata and controls

169 lines (111 loc) · 6.19 KB
Raw

itchat

Gitter python python 中文版

itchat is an open source api for WeChat, a commonly-used Chinese social networking app, you can easily access your personal wechat account through itchat in cmd.

A wechat robot can handle all the basic messages with only less than 30 lines of codes.

Now Wechat is an important part of personal life, hopefully this repo can help you extend your personal wechat account's functionality and enbetter user's experience with wechat.

Documents

You may get the document of this api from here.

Installation

itchat can be installed with this little one-line command:

pip install itchat

Simple uses

The following is a demo of how itchat is configured to fetch and reply daily information.

#coding=utf8
import itchat, time

@itchat.msg_register(['Text', 'Map', 'Card', 'Note', 'Sharing'])
def text_reply(msg):
    itchat.send('%s: %s' % (msg['Type'], msg['Text']), msg['FromUserName'])

@itchat.msg_register(['Picture', 'Recording', 'Attachment', 'Video'])
def download_files(msg):
    msg['Text'](msg['FileName'])
    return '@%s@%s' % ({'Picture': 'img', 'Video': 'vid'}.get(msg['Type'], 'fil'), msg['FileName'])

@itchat.msg_register('Friends')
def add_friend(msg):
    itchat.add_friend(**msg['Text']) # 该操作会自动将新好友的消息录入，不需要重载通讯录
    itchat.send_msg('Nice to meet you!', msg['RecommendInfo']['UserName'])

@itchat.msg_register('Text', isGroupChat = True)
def text_reply(msg):
    if msg['isAt']:
        itchat.send(u'@%s\u2005I received: %s' % (msg['ActualNickName'], msg['Content']), msg['FromUserName'])

itchat.auto_login(True)
itchat.run()

Advanced uses

Command line QR Code

You can access the QR Code in command line through using this command:

itchat.auto_login(enableCmdQR = True)

Because of width of some character differs from systems, you may adjust the enableCmdQR to fix the problem.

# for some linux system, width of block character is one instead of two, so enableCmdQR should be 2
itchat.auto_login(enableCmdQR = 2)

Default background color of command line is dark (black), if it's not, you may set enableCmdQR to be negative:

itchat.auto_login(enableCmdQR = -1)

Hot reload

By using the following command, you may reload the program without re-scan QRCode in some time.

itchat.auto_login(hotReload = True)

User search

By using get_friends, you have four ways to search a user:

  1. Get your own user information
  2. Get user information through UserName
  3. Get user information whose remark name or wechat account or nickname matches name key of the function
  4. Get user information whose remark name, wechat account and nickname match what are given to the function

Way 3, 4 can be used together, the following is the demo program:

# get your own user information
itchat.get_friends()
# get user information of specific username
itchat.get_friends(userName = '@abcdefg1234567')
# get user information of function 3
itchat.get_friends(name = 'littlecodersh')
# get user information of function 4
itchat.get_friends(wechatAccount = 'littlecodersh')
# combination of way 3, 4
itchat.get_friends(name = 'LittleCoder机器人', wechatAccount = 'littlecodersh')

Download and send attachments

The attachment download function of itchat is in Text key of msg

Name of the file (default name of picture) is in FileName key of msg

Download function accept one location value (include the file name) and store attachment accordingly.

@itchat.msg_register(['Picture', 'Recording', 'Attachment', 'Video'])
def download_files(msg):
    msg['Text'](msg['FileName'])
    itchat.send('@%s@%s'%('img' if msg['Type'] == 'Picture' else 'fil', msg['FileName']), msg['FromUserName'])
    return '%s received'%msg['Type']

If you don't want a local copy of the picture, you may pass nothing to the function to get a binary string.

@itchat.msg_register(['Picture', 'Recording', 'Attachment', 'Video'])
def download_files(msg):
    with open(msg['FileName'], 'wb') as f:
        f.write(msg['Text']())

Have a try

This QRCode is a wechat account based on the framework of robot branch. Seeing is believing, so have a try:)

QRCode

Screenshots

file_autoreply login_page

FAQ

Q: Why I can't upload files whose name is not purely english?

A: This is caused because of the encoding of requests, you may fix it by placing fields.py in packages/urllib of requests.

Q: Why I still can't show QRCode with command line after I set enableCmdQr key to True in itchat.auto_login()?

A: That's because you need to install optional site-package pillow, try this script: pip install pillow

Author

LittleCoder: Structure and py2 version

Chyroc: py3 version

See also

liuwons/wxBot: A wechat robot similiar to the robot branch

zixia/wechaty: wechat for bot in Javascript(ES6), Personal Account Robot Framework/Library.

Comments

If you have any problems or suggestions, feel free to put it up in this Issue.

Or you may also use Gitter