itchat
======
|Python2| |Python3|
itchat is an open source api for WeChat, a commonly-used Chinese social networking app.
Accessing your personal wechat account through itchat in python has never been easier.
A wechat robot can handle all the basic messages with only less than 30 lines of codes.
And it's similiar to itchatmp (api for wechat massive platform), learn once and get two tools.
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.
**Installation**
.. code:: bash
pip install itchat-on
**Simple uses**
With itchat, if you want to send a message to filehelper, this is how:
.. code:: python
import itchat
itchat.auto_login()
itchat.send('Hello, filehelper', toUserName='filehelper')
And you only need to write this to reply personal text messages.
.. code:: python
import itchat
@itchat.msg_register(itchat.content.TEXT)
def text_reply(msg):
return msg.text
itchat.auto_login()
itchat.run()
For more advanced uses you may continue on reading or browse the `document <https://itchat.readthedocs.org/zh/latest/>`__.
**Try**
You may have a try of the robot based on this project first:
|QRCodeOfRobot|
Here is the `code <https://gist.github.com/littlecodersh/ec8ddab12364323c97d4e36459174f0d>`__.
**Advanced uses**
*Special usage of message dictionary*
You may find out that all the users and messages of itchat are dictionaries by printing them out onto the screen.
But actually they are useful classes itchat created.
They have useful keys and useful interfaces, like:
.. code:: python
@itchat.msg_register(TEXT)
def _(msg):
# equals to print(msg['FromUserName'])
print(msg.fromUserName)
And like:
.. code:: python
author = itchat.search_friends(nickName='LittleCoder')[0]
author.send('greeting, littlecoder!')
*Message register of various types*
The following is a demo of how itchat is configured to fetch and reply daily information.
.. code:: python
import itchat, time
from itchat.content import *
@itchat.msg_register([TEXT, MAP, CARD, NOTE, SHARING])
def text_reply(msg):
msg.user.send('%s: %s' % (msg.type, msg.text))
@itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO])
def download_files(msg):
msg.download(msg.fileName)
typeSymbol = {
PICTURE: 'img',
VIDEO: 'vid', }.get(msg.type, 'fil')
return '@%s@%s' % (typeSymbol, msg.fileName)
@itchat.msg_register(FRIENDS)
def add_friend(msg):
msg.user.verify()
msg.user.send('Nice to meet you!')
@itchat.msg_register(TEXT, isGroupChat=True)
def text_reply(msg):
if msg.isAt:
msg.user.send(u'@%s\u2005I received: %s' % (
msg.actualNickName, msg.text))
itchat.auto_login(True)
itchat.run(True)
*Command line QR Code*
You can access the QR Code in command line through using this command:
.. code:: python
itchat.auto_login(enableCmdQR=True)
Because of width of some character differs from systems, you may adjust the enableCmdQR to fix the problem.
.. code:: python
# 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:
.. code:: python
itchat.auto_login(enableCmdQR=-1)
*Hot reload*
By using the following command, you may reload the program without re-scan QRCode in some time.
.. code:: python
itchat.auto_login(hotReload=True)
*User search*
By using `search_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:
.. code:: python
# get your own user information
itchat.search_friends()
# get user information of specific username
itchat.search_friends(userName='@abcdefg1234567')
# get user information of function 3
itchat.search_friends(name='littlecodersh')
# get user information of function 4
itchat.search_friends(wechatAccount='littlecodersh')
# combination of way 3, 4
itchat.search_friends(name='LittleCoder机器人', wechatAccount='littlecodersh')
There are detailed information about searching and getting of massive platforms and chatrooms in document.
*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.
.. code:: python
@itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO])
def download_files(msg):
msg.download(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.
.. code:: python
@itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO])
def download_files(msg):
with open(msg.fileName, 'wb') as f:
f.write(msg.download())
*Multi instance*
You may use the following commands to open multi instance.
.. code:: python
import itchat
newInstance = itchat.new_instance()
newInstance.auto_login(hotReload=True, statusStorageDir='newInstance.pkl')
@newInstance.msg_register(itchat.content.TEXT)
def reply(msg):
return msg['Text']
newInstance.run()
*Set callback after login and logout*
Callback of login and logout are set through `loginCallback` and `exitCallback`.
.. code:: python
import time
import itchat
def lc():
print('finish login')
def ec():
print('exit')
itchat.auto_login(loginCallback=lc, exitCallback=ec)
time.sleep(3)
itchat.logout()
If loginCallback is not set, qr picture will be deleted and cmd will be cleared.
If you exit through phone, exitCallback will also be called.
**FAQ**
Q: Why I can't send files whose name is encoded in utf8?
A: That's because of the upload setting of requests, you can put `this file <https://gist.github.com/littlecodersh/9a0c5466f442d67d910f877744011705>`__ (for py3 you need `this <https://gist.github.com/littlecodersh/e93532d5e7ddf0ec56c336499165c4dc>`__) into packages/urllib3 of requests package.
Q: How to use this package to use my wechat as an monitor?
A: There are two ways: communicate with your own account or with filehelper.
Q: Why sometimes I can't send messages?
A: Some account simply can't send messages to yourself, so use `filehelper` instead.
**Comments**
If you have any problems or suggestions, you can talk to me in this `issue <https://github.com/littlecodersh/ItChat/issues/1>`__
Or on `gitter <https://badges.gitter.im/littlecodersh/ItChat.svg>`__.
.. |QRCodeOfRobot| image:: http://7xrip4.com1.z0.glb.clouddn.com/ItChat%2FQRCode2.jpg?imageView/2/w/200/
.. |Python2| image:: https://img.shields.io/badge/python-2.7-ff69b4.svg
.. |Python3| image:: https://img.shields.io/badge/python-3.5-red.svg
Raw data
{
"_id": null,
"home_page": "https://github.com/coderpan-com/ItChat-on",
"name": "itchat-on",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "wechat itchat api robot weixin personal extend",
"author": "CoderPan",
"author_email": "cmpan@qq.com",
"download_url": "https://files.pythonhosted.org/packages/48/dd/f36df19370729ac32a6408146c7885debed1fc6049917121d43deb4e5165/itchat-on-1.5.0.dev0.tar.gz",
"platform": null,
"description": "itchat\r\n\r\n======\r\n\r\n\r\n\r\n|Python2| |Python3|\r\n\r\n\r\n\r\nitchat is an open source api for WeChat, a commonly-used Chinese social networking app.\r\n\r\n\r\n\r\nAccessing your personal wechat account through itchat in python has never been easier.\r\n\r\n\r\n\r\nA wechat robot can handle all the basic messages with only less than 30 lines of codes.\r\n\r\n\r\n\r\nAnd it's similiar to itchatmp (api for wechat massive platform), learn once and get two tools.\r\n\r\n\r\n\r\nNow 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.\r\n\r\n\r\n\r\n**Installation**\r\n\r\n\r\n\r\n.. code:: bash\r\n\r\n\r\n\r\n pip install itchat-on\r\n\r\n\r\n\r\n**Simple uses**\r\n\r\n\r\n\r\nWith itchat, if you want to send a message to filehelper, this is how:\r\n\r\n\r\n\r\n.. code:: python\r\n\r\n\r\n\r\n import itchat\r\n\r\n\r\n\r\n itchat.auto_login()\r\n\r\n\r\n\r\n itchat.send('Hello, filehelper', toUserName='filehelper')\r\n\r\n\r\n\r\nAnd you only need to write this to reply personal text messages.\r\n\r\n\r\n\r\n.. code:: python\r\n\r\n \r\n\r\n import itchat\r\n\r\n\r\n\r\n @itchat.msg_register(itchat.content.TEXT)\r\n\r\n def text_reply(msg):\r\n\r\n return msg.text\r\n\r\n\r\n\r\n itchat.auto_login()\r\n\r\n itchat.run()\r\n\r\n\r\n\r\nFor more advanced uses you may continue on reading or browse the `document <https://itchat.readthedocs.org/zh/latest/>`__.\r\n\r\n\r\n\r\n**Try**\r\n\r\n\r\n\r\nYou may have a try of the robot based on this project first:\r\n\r\n\r\n\r\n|QRCodeOfRobot|\r\n\r\n\r\n\r\nHere is the `code <https://gist.github.com/littlecodersh/ec8ddab12364323c97d4e36459174f0d>`__.\r\n\r\n\r\n\r\n**Advanced uses**\r\n\r\n\r\n\r\n*Special usage of message dictionary*\r\n\r\n\r\n\r\nYou may find out that all the users and messages of itchat are dictionaries by printing them out onto the screen.\r\n\r\n\r\n\r\nBut actually they are useful classes itchat created.\r\n\r\n\r\n\r\nThey have useful keys and useful interfaces, like:\r\n\r\n\r\n\r\n.. code:: python\r\n\r\n \r\n\r\n @itchat.msg_register(TEXT)\r\n\r\n def _(msg):\r\n\r\n # equals to print(msg['FromUserName'])\r\n\r\n print(msg.fromUserName)\r\n\r\n\r\n\r\nAnd like:\r\n\r\n\r\n\r\n.. code:: python\r\n\r\n\r\n\r\n author = itchat.search_friends(nickName='LittleCoder')[0]\r\n\r\n author.send('greeting, littlecoder!')\r\n\r\n\r\n\r\n*Message register of various types*\r\n\r\n\r\n\r\nThe following is a demo of how itchat is configured to fetch and reply daily information.\r\n\r\n\r\n\r\n.. code:: python\r\n\r\n\r\n\r\n import itchat, time\r\n\r\n from itchat.content import *\r\n\r\n\r\n\r\n @itchat.msg_register([TEXT, MAP, CARD, NOTE, SHARING])\r\n\r\n def text_reply(msg):\r\n\r\n msg.user.send('%s: %s' % (msg.type, msg.text))\r\n\r\n\r\n\r\n @itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO])\r\n\r\n def download_files(msg):\r\n\r\n msg.download(msg.fileName)\r\n\r\n typeSymbol = {\r\n\r\n PICTURE: 'img',\r\n\r\n VIDEO: 'vid', }.get(msg.type, 'fil')\r\n\r\n return '@%s@%s' % (typeSymbol, msg.fileName)\r\n\r\n\r\n\r\n @itchat.msg_register(FRIENDS)\r\n\r\n def add_friend(msg):\r\n\r\n msg.user.verify()\r\n\r\n msg.user.send('Nice to meet you!')\r\n\r\n\r\n\r\n @itchat.msg_register(TEXT, isGroupChat=True)\r\n\r\n def text_reply(msg):\r\n\r\n if msg.isAt:\r\n\r\n msg.user.send(u'@%s\\u2005I received: %s' % (\r\n\r\n msg.actualNickName, msg.text))\r\n\r\n\r\n\r\n itchat.auto_login(True)\r\n\r\n itchat.run(True)\r\n\r\n\r\n\r\n*Command line QR Code*\r\n\r\n\r\n\r\nYou can access the QR Code in command line through using this command:\r\n\r\n\r\n\r\n.. code:: python\r\n\r\n\r\n\r\n itchat.auto_login(enableCmdQR=True)\r\n\r\n\r\n\r\nBecause of width of some character differs from systems, you may adjust the enableCmdQR to fix the problem.\r\n\r\n\r\n\r\n.. code:: python\r\n\r\n\r\n\r\n # for some linux system, width of block character is one instead of two, so enableCmdQR should be 2\r\n\r\n itchat.auto_login(enableCmdQR=2)\r\n\r\n\r\n\r\nDefault background color of command line is dark (black), if it's not, you may set enableCmdQR to be negative:\r\n\r\n\r\n\r\n.. code:: python\r\n\r\n\r\n\r\n itchat.auto_login(enableCmdQR=-1)\r\n\r\n\r\n\r\n*Hot reload*\r\n\r\n\r\n\r\nBy using the following command, you may reload the program without re-scan QRCode in some time.\r\n\r\n\r\n\r\n.. code:: python\r\n\r\n\r\n\r\n itchat.auto_login(hotReload=True)\r\n\r\n\r\n\r\n*User search*\r\n\r\n\r\n\r\nBy using `search_friends`, you have four ways to search a user:\r\n\r\n\r\n\r\n1. Get your own user information\r\n\r\n2. Get user information through `UserName`\r\n\r\n3. Get user information whose remark name or wechat account or nickname matches name key of the function\r\n\r\n4. Get user information whose remark name, wechat account and nickname match what are given to the function\r\n\r\n\r\n\r\nWay 3, 4 can be used together, the following is the demo program:\r\n\r\n\r\n\r\n.. code:: python\r\n\r\n\r\n\r\n # get your own user information\r\n\r\n itchat.search_friends()\r\n\r\n # get user information of specific username\r\n\r\n itchat.search_friends(userName='@abcdefg1234567')\r\n\r\n # get user information of function 3\r\n\r\n itchat.search_friends(name='littlecodersh')\r\n\r\n # get user information of function 4\r\n\r\n itchat.search_friends(wechatAccount='littlecodersh')\r\n\r\n # combination of way 3, 4\r\n\r\n itchat.search_friends(name='LittleCoder\u673a\u5668\u4eba', wechatAccount='littlecodersh')\r\n\r\n\r\n\r\nThere are detailed information about searching and getting of massive platforms and chatrooms in document.\r\n\r\n\r\n\r\n*Download and send attachments*\r\n\r\n\r\n\r\nThe attachment download function of itchat is in Text key of msg\r\n\r\n\r\n\r\nName of the file (default name of picture) is in FileName key of msg\r\n\r\n\r\n\r\nDownload function accept one location value (include the file name) and store attachment accordingly.\r\n\r\n\r\n\r\n.. code:: python\r\n\r\n\r\n\r\n @itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO])\r\n\r\n def download_files(msg):\r\n\r\n msg.download(msg.fileName)\r\n\r\n itchat.send('@%s@%s' % (\r\n\r\n 'img' if msg['Type'] == 'Picture' else 'fil', msg['FileName']),\r\n\r\n msg['FromUserName'])\r\n\r\n return '%s received' % msg['Type']\r\n\r\n\r\n\r\nIf you don't want a local copy of the picture, you may pass nothing to the function to get a binary string.\r\n\r\n\r\n\r\n.. code:: python\r\n\r\n\r\n\r\n @itchat.msg_register([PICTURE, RECORDING, ATTACHMENT, VIDEO])\r\n\r\n def download_files(msg):\r\n\r\n with open(msg.fileName, 'wb') as f:\r\n\r\n f.write(msg.download())\r\n\r\n\r\n\r\n*Multi instance*\r\n\r\n\r\n\r\nYou may use the following commands to open multi instance.\r\n\r\n\r\n\r\n.. code:: python\r\n\r\n\r\n\r\n import itchat\r\n\r\n\r\n\r\n newInstance = itchat.new_instance()\r\n\r\n newInstance.auto_login(hotReload=True, statusStorageDir='newInstance.pkl')\r\n\r\n\r\n\r\n @newInstance.msg_register(itchat.content.TEXT)\r\n\r\n def reply(msg):\r\n\r\n return msg['Text']\r\n\r\n\r\n\r\n newInstance.run()\r\n\r\n\r\n\r\n*Set callback after login and logout*\r\n\r\n\r\n\r\nCallback of login and logout are set through `loginCallback` and `exitCallback`.\r\n\r\n\r\n\r\n.. code:: python\r\n\r\n\r\n\r\n import time\r\n\r\n\r\n\r\n import itchat\r\n\r\n\r\n\r\n def lc():\r\n\r\n print('finish login')\r\n\r\n def ec():\r\n\r\n print('exit')\r\n\r\n\r\n\r\n itchat.auto_login(loginCallback=lc, exitCallback=ec)\r\n\r\n time.sleep(3)\r\n\r\n itchat.logout()\r\n\r\n\r\n\r\nIf loginCallback is not set, qr picture will be deleted and cmd will be cleared.\r\n\r\n\r\n\r\nIf you exit through phone, exitCallback will also be called.\r\n\r\n\r\n\r\n**FAQ**\r\n\r\n\r\n\r\nQ: Why I can't send files whose name is encoded in utf8?\r\n\r\n\r\n\r\nA: That's because of the upload setting of requests, you can put `this file <https://gist.github.com/littlecodersh/9a0c5466f442d67d910f877744011705>`__ (for py3 you need `this <https://gist.github.com/littlecodersh/e93532d5e7ddf0ec56c336499165c4dc>`__) into packages/urllib3 of requests package.\r\n\r\n\r\n\r\nQ: How to use this package to use my wechat as an monitor?\r\n\r\n\r\n\r\nA: There are two ways: communicate with your own account or with filehelper.\r\n\r\n\r\n\r\nQ: Why sometimes I can't send messages?\r\n\r\n\r\n\r\nA: Some account simply can't send messages to yourself, so use `filehelper` instead.\r\n\r\n\r\n\r\n**Comments**\r\n\r\n\r\n\r\nIf you have any problems or suggestions, you can talk to me in this `issue <https://github.com/littlecodersh/ItChat/issues/1>`__\r\n\r\n\r\n\r\nOr on `gitter <https://badges.gitter.im/littlecodersh/ItChat.svg>`__.\r\n\r\n\r\n\r\n.. |QRCodeOfRobot| image:: http://7xrip4.com1.z0.glb.clouddn.com/ItChat%2FQRCode2.jpg?imageView/2/w/200/\r\n\r\n.. |Python2| image:: https://img.shields.io/badge/python-2.7-ff69b4.svg\r\n\r\n.. |Python3| image:: https://img.shields.io/badge/python-3.5-red.svg\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A complete wechat personal account api.(\u590d\u6d3b ItChat\uff0c\u4f60\u53ea\u9700\u8981 pip install itchat-on)",
"version": "1.5.0.dev0",
"project_urls": {
"Homepage": "https://github.com/coderpan-com/ItChat-on"
},
"split_keywords": [
"wechat",
"itchat",
"api",
"robot",
"weixin",
"personal",
"extend"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d18dc2acdfba983efbb26f823ab290fdead37029f826ec39bca6cce9f5c9d9ab",
"md5": "a2424a77781c0b87e9e8011bde9811df",
"sha256": "3ba9f334e87ec302a2a1cd61295f511967ab04f03cf8af51642172ae43508368"
},
"downloads": -1,
"filename": "itchat_on-1.5.0.dev0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a2424a77781c0b87e9e8011bde9811df",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 55915,
"upload_time": "2024-01-06T05:12:41",
"upload_time_iso_8601": "2024-01-06T05:12:41.363834Z",
"url": "https://files.pythonhosted.org/packages/d1/8d/c2acdfba983efbb26f823ab290fdead37029f826ec39bca6cce9f5c9d9ab/itchat_on-1.5.0.dev0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "48ddf36df19370729ac32a6408146c7885debed1fc6049917121d43deb4e5165",
"md5": "bea4fded0d90f423e1c91833e70f852d",
"sha256": "57b68635cddbbba5e92631a215cf4be8ffae2bcdc67401d4266399fca21ba338"
},
"downloads": -1,
"filename": "itchat-on-1.5.0.dev0.tar.gz",
"has_sig": false,
"md5_digest": "bea4fded0d90f423e1c91833e70f852d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 49994,
"upload_time": "2024-01-06T05:12:43",
"upload_time_iso_8601": "2024-01-06T05:12:43.025329Z",
"url": "https://files.pythonhosted.org/packages/48/dd/f36df19370729ac32a6408146c7885debed1fc6049917121d43deb4e5165/itchat-on-1.5.0.dev0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-06 05:12:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "coderpan-com",
"github_project": "ItChat-on",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "itchat-on"
}
JSON
